[PATCH 6/6] user: Remove nit-picky warnings.

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Feb 22 06:46:02 UTC 2019


On 21/02/2019 22:20, Chris Johns wrote:
> On 21/2/19 5:13 pm, Sebastian Huber wrote:
>> On 21/02/2019 03:43,chrisj at rtems.org  wrote:
>>> diff --git a/user/bsps/bsps-powerpc.rst b/user/bsps/bsps-powerpc.rst
>>> index 0ee51d1..365571f 100644
>>> --- a/user/bsps/bsps-powerpc.rst
>>> +++ b/user/bsps/bsps-powerpc.rst
>>> @@ -94,7 +94,7 @@ Boot via U-Boot
>>>    The application executable file (ELF file) must be converted to an U-Boot
>>>    image.  Use the following commands:
>>>    -::
>>> +.. code-block:: shell
>>>          powerpc-rtems5-objcopy -O binary app.exe app.bin
>>>        gzip -9 -f -c app.bin > app.bin.gz
>> I think the "shell" syntax highlighting is quite erratic. I would rather use
>> "none".
> I think a list of shell commands is ok, ie like a script, I suspect it is when
> there is output mixed in as well.

The colouring of "variables" and numbers is also quite odd sometimes. I 
found no benefit in using it.

>
> I have used `$` in shell command lists to indicate a `user` prompt and a command
> to enter and `#` for `root`, looking at your Quick Start changes you do not use
> a prompt. Should these be made consistent?

Omitting the '$' or whatever has the benefit that you can copy and past 
directly multiple commands from the example to your terminal.

-- 
Sebastian Huber, embedded brains GmbH

Address : Dornierstr. 4, D-82178 Puchheim, Germany
Phone   : +49 89 189 47 41-16
Fax     : +49 89 189 47 41-09
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.




More information about the devel mailing list