On Mar 29, 2010, at 11:37 AM, Darren J Moffat wrote:

> 
> 
> On 29/03/2010 19:21, Don Cragun wrote:
>> On Mar 29, 2010, at 10:42 AM, Darren J Moffat wrote:
>> 
>>> On 29/03/2010 18:30, Don Cragun wrote:
>>>>> +         +   Indicates the file/directory was added in the later dataset
>>>>> +         -   Indicates the file/directory was removed in the later 
>>>>> dataset
>>>>> +         M   Indicates the file/directory was modified in the later 
>>>>> dataset
>>>>> +         R   Indicates the file/directory was renamed in the later 
>>>>> dataset
>>>> 
>>>> Again, "file/directory" should just be "file" in all four lines above.
>>> 
>>> While a that may be technically true I personally found it very useful that 
>>> it said file/directory.  Particularly since this isn't a POSIX C API man 
>>> page.
>>> 
>>> I'd rather it made it clear that both files and directories, and all other 
>>> types of filesystem objects are supported here, and that it do so by 
>>> explicitly saying file and directory.
>> 
>> I'm not an ARC member, so you are free to ignore my comments.  But,
>> explicitly saying "file of any type and file of type directory" makes
>> absolutely no sense to me.  I don't see that it is clearer; it just
>> raises the question of what does "file" mean on this man page if
>> "directory" is not a type of file.
> 
> Think like a user that doesn't know C programming and how these things are 
> implemented and doesn't know what POSIX/SUS is.
> 
>> I know you don't like POSIX/SUS based man pages, but<sys/stat.h>  is
>> pretty basic.  It clearly shows that the S_IFMT portion of the st_mode
>> field (which has type mode_t) specifies the file type.
> 
> Which is fine for a developer but not for an end admin or user.
> 
> Remember ZFS commands can be delegated to users.  Users thing in terms of 
> files and directories (and depending on where they came from they might still 
> be calling them folders not directories).
> 

OK.  I see what you're trying to do now.  Please change "the
file/directory" on all four lines to "something".  Naive users won't
get lost in the details and savvy programmers won't be confused by
the real, overlapping definitions.

 - Don

> 
> -- 
> Darren J Moffat

Reply via email to