Skip to content

Commit a316d3d

Browse files
wpietwpiet
committed
docs: Fix the layout in multiple .rst files for the PDF output
Fixes formatting issues in the `command list` section.
1 parent 0c237bf commit a316d3d

10 files changed

+218
-184
lines changed

‎docs/command_list/newt_build.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,13 @@ You can specify a list of target names, separated by a space, to build multiple
3333
Examples
3434
^^^^^^^^
3535

36-
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
37-
| Usage | Explanation |
38-
+====================================+================================================================================================================================================================================================================================================================+
39-
| ``newt build my_blinky_sim`` | Builds an executable for the ``my_blinky_sim`` target. For example, if the ``my_blinky_sim`` target has ``app`` set to ``apps/blinky``, you will find the generated .elf, .a, and .lst files in the 'bin/targets/my\_blinky\_sim/app/apps/blinky' directory. |
40-
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
41-
| ``newt build my_blinky_sim myble`` | Builds the images for the applications defined by the ``my_blinky_sim`` and ``myble`` targets. |
42-
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
36+
.. tabularcolumns:: |l|p{10cm}|
37+
.. table::
38+
39+
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
40+
| Usage | Explanation |
41+
+====================================+================================================================================================================================================================================================================================================================+
42+
| ``newt build my_blinky_sim`` | Builds an executable for the ``my_blinky_sim`` target. For example, if the ``my_blinky_sim`` target has ``app`` set to ``apps/blinky``, you will find the generated .elf, .a, and .lst files in the 'bin/targets/my\_blinky\_sim/app/apps/blinky' directory. |
43+
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
44+
| ``newt build my_blinky_sim myble`` | Builds the images for the applications defined by the ``my_blinky_sim`` and ``myble`` targets. |
45+
+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

‎docs/command_list/newt_clean.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,15 @@ Deletes all the build artifacts generated for the ``target-name`` target. It doe
3131
Examples
3232
^^^^^^^^
3333

34-
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
35-
| Usage | Explanation |
36-
+====================================+==========================================================================================================================================================================================+
37-
| ``newt clean myble`` | Deletes the 'bin/targets/myble' directory where all the build artifacts generated from the ``myble`` target build are stored. |
38-
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
39-
| ``newt clean my_blinky_sim myble`` | Deletes the 'bin/targets/my\_blinky\_sim' and the 'bin/targets/myble' directories where all the artifacts generated from the ``my_blinky_sim`` and ``myble`` target builds are stored. |
40-
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
41-
| ``newt clean all`` | Removes the artifacts for all target builds. Deletes the top level 'bin' directory. |
42-
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
34+
.. tabularcolumns:: |l|p{10cm}|
35+
.. table::
36+
37+
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
38+
| Usage | Explanation |
39+
+====================================+==========================================================================================================================================================================================+
40+
| ``newt clean myble`` | Deletes the 'bin/targets/myble' directory where all the build artifacts generated from the ``myble`` target build are stored. |
41+
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
42+
| ``newt clean my_blinky_sim myble`` | Deletes the 'bin/targets/my\_blinky\_sim' and the 'bin/targets/myble' directories where all the artifacts generated from the ``my_blinky_sim`` and ``myble`` target builds are stored. |
43+
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
44+
| ``newt clean all`` | Removes the artifacts for all target builds. Deletes the top level 'bin' directory. |
45+
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

‎docs/command_list/newt_create_image.rst

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -33,25 +33,28 @@ To sign an image, provide a .pem file for the ``signing-key`` and an optional ``
3333
Examples
3434
^^^^^^^^
3535

36-
================================================== =================================================================================
37-
Usage Explanation
38-
================================================== =================================================================================
39-
``newt create-image myble2 1.0.1.0`` Creates an image for target ``myble2`` and assigns it version
40-
``1.0.1.0``.
41-
42-
For the following target definition:
43-
44-
| targets/myble2
45-
| app=\@apache-mynewt-core/apps/btshell
46-
| bsp=\@apache-mynewt-core/hw/bsp/nrf52dk
47-
| build\_profile=optimized
48-
| syscfg=STATS\_NAMES=1
49-
50-
the 'bin/targets/myble2/app/apps/btshell/btshell.img' and
51-
'bin/targets/myble2/app/apps/btshell/btshell.hex' files are created,
52-
and the manifest in 'bin/targets/myble2/app/apps/btshell/manifest.json'
53-
is updated with the image information.
54-
55-
``newt create-image myble2 1.0.1.0 private.pem`` Creates an image for target ``myble2`` and assigns it the version
56-
``1.0.1.0``. Signs the image using private key specified by the private.pem file.
57-
================================================== =================================================================================
36+
.. tabularcolumns:: |l|p{7.2cm}|
37+
.. table::
38+
39+
================================================== =================================================================================
40+
Usage Explanation
41+
================================================== =================================================================================
42+
``newt create-image myble2 1.0.1.0`` Creates an image for target ``myble2`` and assigns it version
43+
``1.0.1.0``.
44+
45+
For the following target definition:
46+
47+
| targets/myble2
48+
| app=\@apache-mynewt-core/apps/btshell
49+
| bsp=\@apache-mynewt-core/hw/bsp/nrf52dk
50+
| build\_profile=optimized
51+
| syscfg=STATS\_NAMES=1
52+
53+
the 'bin/targets/myble2/app/apps/btshell/btshell.img' and
54+
'bin/targets/myble2/app/apps/btshell/btshell.hex' files are created,
55+
and the manifest in 'bin/targets/myble2/app/apps/btshell/manifest.json'
56+
is updated with the image information.
57+
58+
``newt create-image myble2 1.0.1.0 private.pem`` Creates an image for target ``myble2`` and assigns it the version
59+
``1.0.1.0``. Signs the image using private key specified by the private.pem file.
60+
================================================== =================================================================================

‎docs/command_list/newt_debug.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,13 @@ Opens a debugger session to the image built for the <target-name> target.
3939
Examples
4040
^^^^^^^^
4141

42-
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
43-
| Usage | Explanation |
44-
+==========================+============================================================================================================================================================================================================================================================================================+
45-
| ``newt debug myble2`` | Opens a J-Link connection and starts a GNU gdb session to debug bin/targets/myble2/app/apps/btshell/btshell.elf when the target is as follows: targets/myble2 app=\@apache-mynewt-core/apps/btshell bsp=\@apache-mynewt-core/hw/bsp/nrf52dk build_profile=optimized syscfg=STATS_NAMES=1 |
46-
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
47-
| ``newt debug myble2 -n`` | Opens a J-Link connection bin/targets/myble2/app/apps/btshell/btshell.elf but do not start GDB on the command line. |
48-
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
42+
.. tabularcolumns:: |l|p{12cm}|
43+
.. table::
44+
45+
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
46+
| Usage | Explanation |
47+
+==========================+============================================================================================================================================================================================================================================================================================+
48+
| ``newt debug myble2`` | Opens a J-Link connection and starts a GNU gdb session to debug bin/targets/myble2/app/apps/btshell/btshell.elf when the target is as follows: targets/myble2 app=\@apache-mynewt-core/apps/btshell bsp=\@apache-mynewt-core/hw/bsp/nrf52dk build_profile=optimized syscfg=STATS_NAMES=1 |
49+
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
50+
| ``newt debug myble2 -n`` | Opens a J-Link connection bin/targets/myble2/app/apps/btshell/btshell.elf but do not start GDB on the command line. |
51+
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)