Re: Doc: Add warning to dangerous command documentation

[Francisco Vila]

2014-02-06 18:23 GMT+01:00 James <address@hidden>:
> On 06/02/14 14:37, Francisco Vila wrote:
>>
>> Hello,
>>
>> in
>>
>>
>> http://www.lilypond.org/doc/v2.19/Documentation/usage/command_002dline-usage
>>
>> #(system "rm -rf /")
>> {
>>    c4^$(ly:gulp-file "/etc/passwd")
>> }
>>
>> I suggest to add a prominent
>>
>>     Warning: do not try this at home
>>
>> I can do the patch.
>
> I' m not sure if you are literally meaning that as text to add 'do not try
> this at home' doesn't necessarily translate.
>
> Use an @warning texinfo box and then perhaps explain in layman's terms what
> the example would do. That should be warning enough.

Yes a @warning texinfo box qualifies as a prominent warning.

>
> Anyone who is delving into this part of LP is going to be aware of the
> implications of 'rm -rf /' anyway.
>

Such an extremely dangerous command deserves some kind of warning in
the LilyPond documentation, to be read by musicians. An user could
fall here by chance with not enough context and try things randomly.

-- 
Francisco Vila. Badajoz (Spain)
www.paconet.org , www.csmbadajoz.com