[linux-cifs-client][patch] doc changes - add options and description of the options in umount.cifs doc

[Shirish Pargaonkar]

On Tue, Jul 7, 2009 at 3:32 PM, Jeff Layton<jlayton at samba.org> wrote:
> On Tue, 2009-07-07 at 14:51 -0500, Shirish Pargaonkar wrote:
>> diff --git a/docs-xml/manpages-3/umount.cifs.8.xml
>> b/docs-xml/manpages-3/umount.cifs.8.xml
>> index 38ce242..388933e 100644
>> --- a/docs-xml/manpages-3/umount.cifs.8.xml
>> +++ b/docs-xml/manpages-3/umount.cifs.8.xml
>> @@ -54,14 +54,52 @@ can rely on specifying explicit entries
>> in /etc/fstab See</para>
>>  <refsect1>
>>         <title>OPTIONS</title>
>>         <variablelist>
>> -        <varlistentry>
>> -                <term>--verbose</term>
>> -                <listitem><para>print additional debugging
>> information</para></listitem>
>> -        </varlistentry>
>> -        <varlistentry>
>> -                <term>--no-mtab</term>
>> -                <listitem><para>Do not update the mtab even if
>> unmount completes successfully (/proc/mounts will still display the
>> correct information)</para></listitem>
>> -        </varlistentry>
>> +               <varlistentry>
>> +                <term>-V</term>
>> +                <listitem><para>Print version and
>> exit.</para></listitem>
>> +               </varlistentry>
>> +               <varlistentry>
>> +                <term>-h</term>
>> +                <listitem><para>Print help message and
>> exit.</para></listitem>
>> +               </varlistentry>
>> +               <varlistentry>
>> +                <term>-n</term>
>> +                <listitem><para>Unmount without changing /etc/mtab.
>> +                               </para></listitem>
>> +               </varlistentry>
>
> I may have mentioned this before, but shouldn't the "-n" option here
> just be a synonym of the --no-mtab option? So the manpage should read
> something like:
>
> -n|--no-mtab
>        Do not update the mtab even if unmount completes successfully
>        (/proc/mounts will still display the correct information)
>
>
> ...that seems to be the standard way to handle synonyms like this in
> manpages. I think the smbd manpage has some options like this
> ("--debuglevel" for instance).
>
>> +               <varlistentry>
>> +                <term>-r</term>
>> +                <listitem><para>In case unmounting fails, try to
>> remount
>> +                               read-only.</para></listitem>
>> +               </varlistentry>
>> +               <varlistentry>
>> +                <term>-f</term>
>> +                <listitem><para>Force unmount (in case of an
>> unreachable
>> +                               server).</para></listitem>
>> +               </varlistentry>
>> +               <varlistentry>
>> +                <term>-l</term>
>> +                <listitem><para>Lazy unmount. Detach the filesystem
>> from
>> +                               the filesysetm hierarchy now, and
>> +                               cleanup all references to the
>> filesystem
>> +                               as soon as it is not busy
>> anymore.</para></listitem>
>> +               </varlistentry>
>> +               <varlistentry>
>> +                <term>-e</term>
>> +                <listitem><para>Mark the mount point as expired.  If
>> a mount
>> +                               point is not currently in use, then an
>> initial
>> +                               call to unmount with this flag fails
>> with the
>> +                               error EAGAIN, but marks the mount
>> point as
>> +                               expired.  The mount point remains
>> expired as
>> +                               long as it isn't accessed by any
>> process.
>> +                               A second unmount call specifying -e
>> unmounts
>> +                               an expired mount point.  This flag
>> cannot be
>> +                               specified with either -f or
>> -l</para></listitem>
>> +               </varlistentry>
>> +               <varlistentry>
>> +                <term>-v</term>
>> +                <listitem><para>Verbose mode.</para></listitem>
>> +               </varlistentry>
>>
>>         </variablelist>
>>  </refsect1>
>
>
>

Did the change.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: umount.cifs.doc.3.patch
Type: application/octet-stream
Size: 2792 bytes
Desc: not available
Url : http://lists.samba.org/archive/linux-cifs-client/attachments/20090707/15762306/umount.cifs.doc.3-0001.obj