Re: cvs commit: src/sbin/mdconfig mdconfig.8

From: Pawel Jakub Dawidek <pjd_at_FreeBSD.org>
Date: Fri, 9 Nov 2007 21:42:51 +0100
On Fri, Nov 09, 2007 at 09:50:52PM +0200, Giorgos Keramidas wrote:
> On 2007-11-09 20:22, Pawel Jakub Dawidek <pjd_at_FreeBSD.org> wrote:
> >>> Another trick is to just skip '-t vnode' as it is assumed when -f is
> >>> used.
> >>
> >> Nice to know :)  Should I update mdconfig.8 again?  I was a bit worried
> >> about thhe `backquoted command` length, but it seems to fit nicely even
> >> in console windows.  Reducing the line-length a bit more is not strictly
> >> necessary, but it's worth considering.  Unless it would make the example
> >> more cryptic than useful, I guess :)
> >
> > Yeah, that's my concern too. On the other hand it's a nice hint to show
> > in example. Well, I'll let you decided on that:)
> 
> The default type of `vnode' is explicitly described in the -f option
> help.  I was just a bit careless when reading the manpage, and expected
> the description to be near -t type instead of -f file:
> 
>     -f file
> 	Filename to use for the vnode type memory disk.  Options
> 	-a and -t vnode are implied if not specified.
> 
> We can probably reduce the command-length, but expand the description of
> the example.
> 
> How about this change?
> 
> %%%
> Index: mdconfig.8
> ===================================================================
> RCS file: /home/ncvs/src/sbin/mdconfig/mdconfig.8,v
> retrieving revision 1.38
> diff -u -r1.38 mdconfig.8
> --- mdconfig.8	9 Nov 2007 18:02:51 -0000	1.38
> +++ mdconfig.8	9 Nov 2007 19:49:36 -0000
> _at__at_ -216,9 +216,15 _at__at_
>  mount /dev/md0c /mnt
>  .Ed
>  .Pp
> -To mount an ISO 9660 CD image file:
> +To mount an ISO 9660 CD image file using the default
> +.Ar type
> +of
> +.Cm vnode ,
> +for the memory disk and the first available
> +.Xr md 4
> +device node:
>  .Bd -literal -offset indent
> -mount -t cd9660 /dev/`mdconfig -a -t vnode -f cdimage.iso` /mnt
> +mount -t cd9660 /dev/`mdconfig -a -f cdimage.iso` /mnt
>  .Ed
>  .Sh SEE ALSO
>  .Xr md 4 ,
> %%%

Looks good.

-- 
Pawel Jakub Dawidek                       http://www.wheel.pl
pjd_at_FreeBSD.org                           http://www.FreeBSD.org
FreeBSD committer                         Am I Evil? Yes, I Am!

Received on Fri Nov 09 2007 - 20:43:25 UTC