rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 03:46:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add commands and output to the README.

Browse Source
This commit is contained in:
Chris Johns 2019-02-27 17:28:00 +11:00
parent 2674d6a949
commit 921037f12f
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.txt
View File

@ -415,14 +415,34 @@ existing documentation for an example and if unsure ask.
5 ^^^^^^ Sub-sub-sub-section 5 ^^^^^^ Sub-sub-sub-section
6 ~~~~~~ Sub-sub-sub-sub-section 6 ~~~~~~ Sub-sub-sub-sub-section
5. For literal output, such as shell commands and code use '::' at the trailing 5. For literal output, such as shell commands and code do not use '::'
edge of the previous paragraph. Use the '.. code-block::' with at the trailing edge of the previous paragraph as it generates
'c' for C code and 'shell' for shell code and terminal output. If you need warnings as the autodetect fails to find a suitable format. Use the
line number use: '.. code-block::' with a suitable lexical label. The lexers are:
http://pygments.org/docs/lexers/
Use the short names. For C code use 'c' code and 'shell' for shell
scripts and for terminal output use 'none'. If you need line
numbers use:
.. code-block:: shell .. code-block:: shell
:linenos: :linenos:
We support two forms of commands and outputs.
The first is to have a shell command block with just the commands
and if required an output block with the output or some of the
output. Use 'none' for the output block. Make sure the text clearly
states the block is the output, if it has been edited to shorten
the amount of output and if there are any special operating modes,
for example needing to be 'root'.
The second is to use a single block of type 'none' with the command
and output together as seen in a terminal session. The commands are
identifed by the standard shell prompt characters where '$' is a
user prompt and '#' is a 'root' prompt.
6. Use the directives for 'note', 'warning', and 'topic'. Do not add 'TIP', 6. Use the directives for 'note', 'warning', and 'topic'. Do not add 'TIP',
'Important' or 'Warning' to the text. Let the mark-up language handle 'Important' or 'Warning' to the text. Let the mark-up language handle
this. The supported directives are: this. The supported directives are: