Code review comment for lp:~cldunlap1/ubuntu/natty/mountall/fix-for-805509

On Monday, July 25, 2011 01:36:39 PM you wrote:
> On Monday, July 25, 2011 12:58:44 PM you wrote:
> > On Mon, Jul 25, 2011 at 04:39:31PM -0000, Chad Dunlap wrote:
> > > === modified file 'man/mountall.8'
> > > --- man/mountall.8 2009-09-16 22:38:18 +0000
> > > +++ man/mountall.8 2011-07-25 16:39:25 +0000
> > > @@ -6,6 +6,30 @@
> > >
> > > .SH SYNOPSIS
> > > .B mountall
> > > .RI [ OPTIONS ]...
> > >
> > > +.SH OPTIONS
> > > +
> > > +--daemon Detach and run in the background
> > > +
> > > +--force-fsck Force check of all filesystems
> > > +
> > > +--fsck-fix Attempt to fix all fsck errors
> > > +
> > > +--no-events Do not emit events after mounting filesystems
> > > +
> > > +--dev-wait-time=value in seconds (Default is 30 seconds, Legal value
> > > between 1second to 2147483647 seconds +.RS <margin position>
> > > + In case of (bootwait,timeout): specify the time to wait for
>
> device to
>
> > > be detected +
> > > +-q, --quiet reduce output to errors only
> > > +
> > > +-v, --verbose increase output to include informational
>
> messages
>
> > > +
> > > +--help display this help and exit
> > > +
> > > +--version output version information and exit
> > > +
> > > +By default, mountall does not detach from the console and remains
in
>
> the
>
> > > foreground. Use +the --daemon option to have it detach.
> >
> > Thanks for your patch!
> >
> > This needs to be written rather differently in order to be formatted
> > properly, because manual page source is run through a specialised set
of
> > processors.
> >
> > You should use "\-" rather than "-" when you mean a literal "-"
> > character instead of a hyphen.
> >
> > Options should be in bold.
> >
> > Instead of laying out a table using tabs, you should do something like
> >
> > this:
> > .TP
> > .B \-\-daemon
> > Detach and run in the background.
> > .TP
> > .B \-\-force\-fsck
> > Force check of all filesystems.
> > ...
> > .TP
> > .B \-\-version
> > Output version information and exit.
> > .PP
> > By default, mountall does not detach from the console and remains in
> > the foreground.
> > Use the \-\-daemon option to have it detach.
> >
> > This should remove the need for that .RS business as well - everything
> > from the second line after .TP onwards until the next paragraph break is
> > indented.
> >
> > Conventionally, the OPTIONS section should come after the DESCRIPTION
> > section.
> >
> > You can read 'man groff_man' for more details on the formatting
language
> > used here, and you can test your page using 'man -l'.
>
> Thank you for the comments. I will get working on the suggestions you
> made. I had some trouble with the formatting. I think the information you
> provided will help me clear up those questions.
>
> Thanks again, and I will get a new fixed posted as soon as I can.

I have made the necessary changes. Please review and let me know if you
need any more changes.

The only way I could get the option and the description of the option to print
on the same line, where appropriate, was to use the .TP 20 command. If I
didn't the description would print, indented, under the option.

Thanks for the information you provided Colin. I appreciate the help!
--

Thank You,
Chad Dunlap