On 27/2/19 6:51 pm, Sebastian Huber wrote: > On 27/02/2019 07:47, Chris Johns wrote: >> On 27/2/19 5:42 pm, Sebastian Huber wrote: >>> On 27/02/2019 07:30, Chris Johns wrote: >>>> diff --git a/README.txt b/README.txt >>>> index e002f60..115d08d 100644 >>>> --- a/README.txt >>>> +++ b/README.txt >>>> @@ -415,14 +415,34 @@ existing documentation for an example and if unsure >>>> ask. >>>> 5 ^^^^^^ Sub-sub-sub-section >>>> 6 ~~~~~~ Sub-sub-sub-sub-section >>>> -5. For literal output, such as shell commands and code use '::' at the >>>> trailing >>>> - edge of the previous paragraph. Use the '.. code-block::' with >>>> - 'c' for C code and 'shell' for shell code and terminal output. If you >>>> need >>>> - line number use: >>>> +5. For literal output, such as shell commands and code do not use '::' >>>> + at the trailing edge of the previous paragraph as it generates >>>> + warnings as the autodetect fails to find a suitable format. Use the >>>> + '.. 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'. >>> I would not use 'shell' for commands. For example in >>> >>> .. code-block:: shell >>> >>> ../configure --enable-rtemsbsp=qoriq_e6500_32 \ >>> QORIQ_IS_HYPERVISOR_GUEST=1 \ >>> QORIQ_UART_0_ENABLE=0 \ >>> QORIQ_UART_1_ENABLE=0 \ >>> QORIQ_TLB1_ENTRY_COUNT=16 >>> >>> the "variables" QORIQ_IS_HYPERVISOR_GUEST, etc. are highlighted and the >>> numeric >>> "values" 0, etc. are highlighted differently. Is this useful? I don't think >>> so. >>> >>> In real shell scripts with variables, loops, conditions and whatever maybe >>> it >>> makes sense to use syntax highlighting. >> Is this a bug with the pigments tool? > > From my point of view this is a bug. I don't have time to report it.
Sure, I can look into that. I suggest we keep the formatting as it should be and get the tool fixed. Chris _______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
