[syslinux] RFC:documents for new modules; Interest in rewriting exiting documentation
Warren Block
wblock at wonkity.com
Mon Sep 3 07:13:02 PDT 2012
On Sun, 2 Sep 2012, Gene Cumm wrote:
>>>> Change from:
>>>> *-w*::
>>>> wait after loading before booting for user input.
>>>> to:
>>>> *-w*::
>>>> after loading and before booting, wait for user input.
>>>
>>> This wording was because I wanted it clear what word the letter stood for.
>>>
>>> *-w*::
>>> (wait) after loading and before booting, wait for user input.
>>>
>>> OR
>>>
>>> *-w* (wait)::
>>> after loading and before booting, wait for user input.
>>>
>>> would likely make it clearer for both which word and the statement.
>>> I'd want to test the output of each with AsciiDoc also.
>>
>> Just be sure that the "(wait)" in the same line as "-W" won't be
>
> It's "-w" not "-W" (case matters).
>
>> misinterpreted as part of the command line option itself. By using
>
> Yeah, that's a part of the contemplation.
>
>> AsciiDoc, you could always make the letter "W" of "Wait" be bolder or
>> brighter than the normal text.
>
> It already is.
Having the description start with the most descriptive word like the
first option above is preferable. Single-quotes produce emphasized
output in AsciiDoc, so
*-w*:: 'wait' for userinput after loading and before booting.
More information about the Syslinux
mailing list