Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHenrik Rentz-Reichert2012-09-10 09:26:17 +0000
committerHenrik Rentz-Reichert2012-09-10 09:26:17 +0000
commita49fd8507422c6ea39179a3ddf18b1d3bdd8811a (patch)
treeadd57e81860ae49f348b4dbe7f8208fb40725487 /plugins
parentc419d0001190244c0b9120510d6c768fdbdc6447 (diff)
downloadorg.eclipse.etrice-a49fd8507422c6ea39179a3ddf18b1d3bdd8811a.tar.gz
org.eclipse.etrice-a49fd8507422c6ea39179a3ddf18b1d3bdd8811a.tar.xz
org.eclipse.etrice-a49fd8507422c6ea39179a3ddf18b1d3bdd8811a.zip
[doc] typos and minor changes
Diffstat (limited to 'plugins')
-rw-r--r--plugins/org.eclipse.etrice.doc/doc/012-Working-with-Tutorials.textile4
-rw-r--r--plugins/org.eclipse.etrice.doc/doc/013-Setting-up-the-Workspace.textile2
-rw-r--r--plugins/org.eclipse.etrice.doc/doc/015-getting-started.textile2
-rw-r--r--plugins/org.eclipse.etrice.doc/doc/032-Setting-up-the-Workspace_C.textile6
-rw-r--r--plugins/org.eclipse.etrice.doc/doc/034-getting-started_C.textile296
5 files changed, 155 insertions, 155 deletions
diff --git a/plugins/org.eclipse.etrice.doc/doc/012-Working-with-Tutorials.textile b/plugins/org.eclipse.etrice.doc/doc/012-Working-with-Tutorials.textile
index 2e81de17d..52014f9b6 100644
--- a/plugins/org.eclipse.etrice.doc/doc/012-Working-with-Tutorials.textile
+++ b/plugins/org.eclipse.etrice.doc/doc/012-Working-with-Tutorials.textile
@@ -1,7 +1,7 @@
h1. Working with the eTrice Tutorials
-The eTrice Tutorials will help you to learn and understand the eTrice Tool and concepts. ETrice supports several target languages. The concepts will not be explained in each language.
+The eTrice Tutorials will help you to learn and understand the eTrice tool and concepts. ETrice supports several target languages. The concepts will not be explained for each language.
Most of the common concepts will be described for Java as target language. To start with a new language the first steps to setup the workspace and to generate and run the first model will be described also. Target language specific aspects will be described as well.
-Therefore the best way to start with eTrice is to perform the Java Tutorials and after that switch to your target language.
+Therefore the best way to start with eTrice is to follow the Java Tutorials and after that switch to your target language.
diff --git a/plugins/org.eclipse.etrice.doc/doc/013-Setting-up-the-Workspace.textile b/plugins/org.eclipse.etrice.doc/doc/013-Setting-up-the-Workspace.textile
index cab1394b5..785e881dc 100644
--- a/plugins/org.eclipse.etrice.doc/doc/013-Setting-up-the-Workspace.textile
+++ b/plugins/org.eclipse.etrice.doc/doc/013-Setting-up-the-Workspace.textile
@@ -1,4 +1,4 @@
-h1. Setting up the Workspace (Java)
+h1. Setting up the Workspace for Java Projects
ETrice generates code out of ROOM models. The code generator and the generated code relies on a runtime framework and on some ready to use model parts. This parts provide services like:
diff --git a/plugins/org.eclipse.etrice.doc/doc/015-getting-started.textile b/plugins/org.eclipse.etrice.doc/doc/015-getting-started.textile
index 4f0b709ec..4bfb01a98 100644
--- a/plugins/org.eclipse.etrice.doc/doc/015-getting-started.textile
+++ b/plugins/org.eclipse.etrice.doc/doc/015-getting-started.textile
@@ -1,4 +1,4 @@
-h1. Tutorial HelloWorld (Java)
+h1. Tutorial HelloWorld for Java
h2. Scope
diff --git a/plugins/org.eclipse.etrice.doc/doc/032-Setting-up-the-Workspace_C.textile b/plugins/org.eclipse.etrice.doc/doc/032-Setting-up-the-Workspace_C.textile
index 0201eda29..e4a01311a 100644
--- a/plugins/org.eclipse.etrice.doc/doc/032-Setting-up-the-Workspace_C.textile
+++ b/plugins/org.eclipse.etrice.doc/doc/032-Setting-up-the-Workspace_C.textile
@@ -1,4 +1,4 @@
-h1. Setting up the Workspace ( C )
+h1. Setting up the Workspace for C Projects
Before you can start with C, some preconditions must be fulfilled:
@@ -25,7 +25,7 @@ From the main menu select _File->New->C Project_.
!images/032-SetupWorkspaceC02.png!
-Name the Project. Select an _Executable->Hello World ANSI C_ as Project type, _MinGW GCC_ as Tool chain and click _Finish_.
+Name the project. Select an _Executable->Hello World ANSI C_ as project type, _MinGW GCC_ as tool chain and click _Finish_.
!images/032-SetupWorkspaceC04.png!
@@ -50,7 +50,7 @@ The C runtime system contains some basic functionalities to run the generated mo
After changing the configuration, the runtime must be built.
-Open the properties of the _org.eclipse.runtime.c_ project and select _C/C++ Build->Settins->Tool Settings_ and select _Includes_.
+Open the properties of the _org.eclipse.runtime.c_ project and select _C/C++ Build->Settings->Tool Settings_ and select _Includes_.
!images/032-SetupWorkspaceC08.png!
diff --git a/plugins/org.eclipse.etrice.doc/doc/034-getting-started_C.textile b/plugins/org.eclipse.etrice.doc/doc/034-getting-started_C.textile
index 35e55b58d..4dd229b72 100644
--- a/plugins/org.eclipse.etrice.doc/doc/034-getting-started_C.textile
+++ b/plugins/org.eclipse.etrice.doc/doc/034-getting-started_C.textile
@@ -1,149 +1,149 @@
-h1. Tutorial HelloWorld ( C )
-
-h2. Scope
-
-In this tutorial you will learn how to create a model for C from scratch. There are some more steps to do in C as in Java. The goal is to get familiar with the additional steps. The Java tutorial is a prerequisite for the following explanations.
-You will perform the following steps:
-
-# create a new model from scratch for C
-# create structure and behavior similar to Java
-# create a launch configuration for the C code generator
-# setup the C environment
-# generate the source code
-# run the model
-
-Make sure that you have set up the workspace as described in _Setting up the workspace ( C )_.
-
-
-h2. Create a new model from scratch
-
-Before you can create a new C-model, you have to create a new C project as described in _Setting up the workspace ( C )_.
-Remember:
-- select the _C/C++_ perspective
-- From the main menue select _File->New->C Project_
-- Name the project _HelloWorldC_
-- Project type is _Executable / Empty C Project_
-- Toolchain is _MinGW_
-
-The workspace should look like this:
-
-!images/034-HelloWorldC01.png!
-
-The next step is to add the model folder:
-Right click on the new project. Select _New->Folder_ and name it _model_.
-
-!images/034-HelloWorldC02.png!
-
-Add the model file to the folder. Right click on the new folder. Select _New->file_ and name it _HelloWorldC.room_.
-
-!images/034-HelloWorldC03.png!
-
-Due to the file ending _.room_, the tool will ask you to add the Xtext nature. Answer with _Yes_.
-
-!images/034-HelloWorldC04.png!
-
-The workspace should look like this:
-
-!images/034-HelloWorldC05.png!
-
-
-
-h2. Create the HelloWorld model
-
-Once the model file is created and the Xtext nature is added, you can create the model as you did it for Java.
-Creating the model is not the focus of this tutorial. Therefore copy and paste the following code into your model file. Optionally you can open and layout the diagrams.
-Recognize the C specific parts:
-- Import CTypes instead of JavaTypes
-- The action code contains C instead of Java. Later versions will contain a common action language, but for the moment the action language is target specific.
-- The application must be shutdown on model level (see also _etRuntimeConfig.h_)
-
-ToDo: shutdown must not depend on the subsystem.
-
-bc..
-RoomModel HelloWorldCModel {
- import room.basic.types.c.* from "../../org.eclipse.etrice.modellib.c/model/CTypes.room"
- SubSystemClass HelloWorldCSubSysClass {
- ActorRef HelloETriceTopRef:AHelloWorldCTop
- }
- ActorClass AHelloWorldCTop {
- Structure { }
- Behavior {
- StateMachine {
- Transition init: initial -> state0 { }
- State state0 {
- entry {
- "printf(\"HelloWorldC !\\n\");"
- "HelloWorldCSubSysClass_shutdown();//exit(0);"
- "\t\t\t\t\t\t"
- }
- }
- }
- }
- }
-}
-bq.
-
-h2. Create a launch configuration to start the C code generator
-
-Other than in Java a launch configuration for the C code generator must be created.
-
-From the _Run_ menu select _Run Configurations_
-
-!images/034-HelloWorldC06.png!
-
-Within the dialog select _eTrice C Generator_ and click the _New_ button to create a new launch configuration.
-
-!images/034-HelloWorldC07.png!
-
-A new configuration should be created. Name it _gen_HelloWorldC_ and add the model via one of the _add_ buttons.
-
-!images/034-HelloWorldC08.png!
-
-In the _Refresh_ tab select _The entire workspace_
-
-!images/034-HelloWorldC09.png!
-
-In the _Common_ tab select _Shared file_ and add the _HelloWorldC_ project via the _Browse_ button.
-
-!images/034-HelloWorldC10.png!
-
-Apply your changes. The new configuration should now exist in your workspace.
-
-!images/034-HelloWorldC11.png!
-
-
-h2. Generate the code
-
-Now you can generate the code as you know it from Java. Right click to the launch configuration and run it as _gen_HelloWorldC_.
-
-!images/034-HelloWorldC12.png!
-
-The code should be generated.
-
-!images/034-HelloWorldC13.png!
-
-h2. Setup the include path
-
-Before you can build the application you must setup the include path for the runtime system. Right click the project and select _Properties_. Add the include path as described in _setting up the workspace_.
-
-!images/034-HelloWorldC14.png!
-
-Add the runtime library.
-
-!images/034-HelloWorldC15.png!
-
-Recognize the name of the library ("org.eclipse.etrice.runtime.c"). The library file on your disk is "liborg.eclipse.etrice.runtime.c.a".
-
-h2. Build and run the model
-
-Now you can build the application. Click the build button to build the application.
-Run the application as _Local C/C++ Application_.
-Verify the output.
-
-!images/034-HelloWorldC16.png!
-
-h2. Summary
-
-You are now familiar with all necessary steps to create, build and run an eTrice C model from scratch. You are able to create a launch configuration to start the code generator and to perform all necessary settings to compile and link the application.
-
+h1. Tutorial HelloWorld for C
+
+h2. Scope
+
+In this tutorial you will learn how to create a model for C from scratch. There are some more steps to do in C compared to Java. The goal is to get familiar with the additional steps. The Java tutorial is a prerequisite for the following explanations.
+You will perform the following steps:
+
+# create a new model from scratch for C
+# create structure and behavior similar to Java
+# create a launch configuration for the C code generator
+# setup the C environment
+# generate the source code
+# run the model
+
+Make sure that you have set up the workspace as described in _Setting up the Workspace for C Projects_.
+
+
+h2. Create a new model from scratch
+
+Before you can create a new C-model, you have to create a new C project as described in _Setting up the Workspace for C Projects_.
+Remember:
+- select the _C/C++_ perspective
+- From the main menue select _File->New->C Project_
+- Name the project _HelloWorldC_
+- Project type is _Executable / Empty C Project_
+- Toolchain is _MinGW_
+
+The workspace should look like this:
+
+!images/034-HelloWorldC01.png!
+
+The next step is to add the model folder:
+Right click on the new project. Select _New->Folder_ and name it _model_.
+
+!images/034-HelloWorldC02.png!
+
+Add the model file to the folder. Right click on the new folder. Select _New->file_ and name it _HelloWorldC.room_.
+
+!images/034-HelloWorldC03.png!
+
+Due to the file ending _.room_, the tool will ask you to add the Xtext nature. Answer with _Yes_.
+
+!images/034-HelloWorldC04.png!
+
+The workspace should look like this:
+
+!images/034-HelloWorldC05.png!
+
+
+
+h2. Create the HelloWorld model
+
+Once the model file is created and the Xtext nature is added, you can create the model as you did it for Java.
+Creating the model is not the focus of this tutorial. Therefore copy and paste the following code into your model file. Optionally you can open and layout the diagrams.
+Recognize the C specific parts:
+- Import CTypes instead of JavaTypes
+- The action code contains C instead of Java. Later versions will contain a common action language, but for the moment the action language is target specific.
+- The application must be shutdown on model level (see also _etRuntimeConfig.h_)
+
+ToDo: shutdown must not depend on the subsystem.
+
+bc..
+RoomModel HelloWorldCModel {
+ import room.basic.types.c.* from "../../org.eclipse.etrice.modellib.c/model/CTypes.room"
+ SubSystemClass HelloWorldCSubSysClass {
+ ActorRef HelloETriceTopRef:AHelloWorldCTop
+ }
+ ActorClass AHelloWorldCTop {
+ Structure { }
+ Behavior {
+ StateMachine {
+ Transition init: initial -> state0 { }
+ State state0 {
+ entry {
+ "printf(\"HelloWorldC !\\n\");"
+ "HelloWorldCSubSysClass_shutdown();//exit(0);"
+ "\t\t\t\t\t\t"
+ }
+ }
+ }
+ }
+ }
+}
+bq.
+
+h2. Create a launch configuration to start the C code generator
+
+Other than in Java a launch configuration for the C code generator must be created.
+
+From the _Run_ menu select _Run Configurations_
+
+!images/034-HelloWorldC06.png!
+
+Within the dialog select _eTrice C Generator_ and click the _New_ button to create a new launch configuration.
+
+!images/034-HelloWorldC07.png!
+
+A new configuration should be created. Name it _gen_HelloWorldC_ and add the model via one of the _add_ buttons.
+
+!images/034-HelloWorldC08.png!
+
+In the _Refresh_ tab select _The entire workspace_
+
+!images/034-HelloWorldC09.png!
+
+In the _Common_ tab select _Shared file_ and add the _HelloWorldC_ project via the _Browse_ button.
+
+!images/034-HelloWorldC10.png!
+
+Apply your changes. The new configuration should now exist in your workspace.
+
+!images/034-HelloWorldC11.png!
+
+
+h2. Generate the code
+
+Now you can generate the code as you know it from Java. Right click on the launch configuration and run it as _gen_HelloWorldC_.
+
+!images/034-HelloWorldC12.png!
+
+The code should be generated.
+
+!images/034-HelloWorldC13.png!
+
+h2. Setup the include path
+
+Before you can build the application you must setup the include path for the runtime system. Right click the project and select _Properties_. Add the include path as described in _setting up the workspace_.
+
+!images/034-HelloWorldC14.png!
+
+Add the runtime library.
+
+!images/034-HelloWorldC15.png!
+
+Recognize the name of the library ("org.eclipse.etrice.runtime.c"). The library file on your disk is "liborg.eclipse.etrice.runtime.c.a".
+
+h2. Build and run the model
+
+Now you can build the application. Click the build button to build the application.
+Run the application as _Local C/C++ Application_.
+Verify the output.
+
+!images/034-HelloWorldC16.png!
+
+h2. Summary
+
+You are now familiar with all necessary steps to create, build and run an eTrice C model from scratch. You are able to create a launch configuration to start the code generator and to perform all necessary settings to compile and link the application.
+
The next tutorial provides an exercise to get more familiar with these working steps. \ No newline at end of file

Back to the top