bug-bash
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation issue


From: Chet Ramey
Subject: Re: Documentation issue
Date: Fri, 27 Oct 2017 14:12:59 -0400
User-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv:52.0) Gecko/20100101 Thunderbird/52.4.0

On 10/26/17 10:50 PM, Clark Wang wrote:
> On Fri, Oct 27, 2017 at 3:00 AM, Eli Barzilay <eli@barzilay.org> wrote:
> 
>> On Thu, Oct 26, 2017 at 2:02 PM, Chet Ramey <chet.ramey@case.edu> wrote:
>>>
>>> It's more of a general statement about arrays, though it appears in
>>> the paragraph that discusses unset, so it's in the man page section on
>>> arrays.  You have to be careful about putting the same information in
>>> too many different places -- the man page is big enough already.
>>
>> I'm very aware of man page bloat and the fact that the bash page is very
>> long as is.  But (a) I think that the builtin section for each command
>> is the more important place for such things; and (b) what I'm suggesting
>> is just a short reminder sentence about the need for quoting unsets for
>> array elements.
>>
>> To make it more concrete, I think that the following change will be
>> good:
>>
>> 1. Drop the current "Care must be taken ... the entire array." two
>>    sentences and replace them with some "See the unset builtin
>>    description below".
>>
> 
> It's not only about unset. You also need to take care of other builtin
> commands:

Let's see if I can find some compromise language that will take care
of the general case. Since it's a compromise, no one will be satisfied,
of course.

-- 
``The lyf so short, the craft so long to lerne.'' - Chaucer
                 ``Ars longa, vita brevis'' - Hippocrates
Chet Ramey, UTech, CWRU    chet@case.edu    http://cnswww.cns.cwru.edu/~chet/



reply via email to

[Prev in Thread] Current Thread [Next in Thread]