You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Place sentences in separate lines in READMEs (#113).
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).
This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
Copy file name to clipboardexpand all lines: renode_rcc/README.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
# renode-RCC
2
-
Building [RTEMS Cross Compilation System (RCC)](https://www.gaisler.com/index.php/products/operating-systems/rtems), has a different directory structure compare to building RTEMS from source (might not be true). This will run RTEMS on leon3 in a renode simulation.
2
+
Building [RTEMS Cross Compilation System (RCC)](https://www.gaisler.com/index.php/products/operating-systems/rtems), has a different directory structure compare to building RTEMS from source (might not be true).
3
+
This will run RTEMS on leon3 in a renode simulation.
Copy file name to clipboardexpand all lines: spaceros/README.md
+11-5
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,9 @@ To build the image, run:
15
15
16
16
The build process will take about 20 or 30 minutes, depending on the host computer.
17
17
18
-
The build process defaults to cloning the `ros2.repos` file from [spaceros](https://github.com/space-ros/space-ros) repository. It looks for a branch with the same name as the current local branch; if it doesn't find one, it falls back to cloning from the main branch. For testing purposes, you can customize both the spaceros repository URL and the branch name by modifying arguments defined in the [Earthfile](./Earthfile).
18
+
The build process defaults to cloning the `ros2.repos` file from [spaceros](https://github.com/space-ros/space-ros) repository.
19
+
It looks for a branch with the same name as the current local branch; if it doesn't find one, it falls back to cloning from the main branch.
20
+
For testing purposes, you can customize both the spaceros repository URL and the branch name by modifying arguments defined in the [Earthfile](./Earthfile).
@@ -107,15 +109,17 @@ spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --ctest-args -LE "(ikos|xfail
107
109
108
110
The tests include running the static analysis tools clang_tidy and cppcheck (which has the MISRA 2012 add-on enabled).
109
111
110
-
You can use colcon's `--packages-select` option to run a subset of packages. For example, to run tests only for the rcpputils package and display the output directly to the console (as well as saving it to a log file), you can run:
112
+
You can use colcon's `--packages-select` option to run a subset of packages.
113
+
For example, to run tests only for the rcpputils package and display the output directly to the console (as well as saving it to a log file), you can run:
111
114
112
115
```
113
116
spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --event-handlers console_direct+ --packages-select rcpputils
114
117
```
115
118
116
119
## Viewing Test Output
117
120
118
-
The output from the tests are stored in XUnit XML files, named *\<tool-name\>*.xunit.xml. After running the unit tests, you can scan the build directory for the various *\*.xunit.xml* files.
121
+
The output from the tests are stored in XUnit XML files, named *\<tool-name\>*.xunit.xml.
122
+
After running the unit tests, you can scan the build directory for the various *\*.xunit.xml* files.
119
123
120
124
For example, a clang_tidy.xunit.xml file looks like this:
121
125
@@ -181,7 +185,8 @@ CONTAINER ID IMAGE COMMAND CREATED
181
185
d10d85c68f0e openrobotics/spaceros "/entrypoint.sh …" 28 minutes ago Up 28 minutes inspiring_moser
182
186
```
183
187
184
-
The container ID in this case, is *d10d85c68f0e*. So, run the following command in the host terminal:
188
+
The container ID in this case, is *d10d85c68f0e*.
189
+
So, run the following command in the host terminal:
@@ -223,7 +228,8 @@ spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --build-base build_ikos --ins
223
228
```
224
229
225
230
The `colcon test` command runs various tests, including IKOS report generation, which reads the IKOS database generated in the previous analysis step and generates a JUnit XML report file.
226
-
After running `colcon test`, you can view the JUnit XML files. For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:
231
+
After running `colcon test`, you can view the JUnit XML files.
232
+
For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:
227
233
228
234
```
229
235
spaceros-user@d10d85c68f0e:~/spaceros$ more build_ikos/rcpputils/test_results/rcpputils/ikos.xunit.xml
0 commit comments