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

Chris Johns chrisj at rtems.org
Thu Feb 21 21:20:45 UTC 2019


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.

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?

For example:

 https://docs.rtems.org/branches/master/user/hosts/posix.html#archlinux
 https://docs.rtems.org/branches/master/user/exe/index.html#system-initialization-handlers

and ..

https://docs.rtems.org/branches/master/user/start/bootstrap.html

Chris



More information about the devel mailing list