[parted-devel] [PATCH 06/10] Correctly describe mkpart command in documentation.

[Joel Granados]

On Wed, Jun 10, 2009 at 09:38:33PM +0200, Jim Meyering wrote:
> Joel Granados Moreno wrote:
> > * doc/parted.texi : Make sure that part-type is portrayed as an
> > optional argument.  Mention the "special behaviors" that mkpart has
> > with specific disk label types.
> > ---
> >  doc/parted.texi |    7 ++++---
> >  1 files changed, 4 insertions(+), 3 deletions(-)
> >
> > diff --git a/doc/parted.texi b/doc/parted.texi
> > index 936a1f6..8b88453 100644
> > --- a/doc/parted.texi
> > +++ b/doc/parted.texi
> > @@ -673,7 +673,7 @@ Make a @var{fat32} file system on partition 2.
> >  @cindex mkpart, command description
> >  @cindex command description, mkpart
> >
> > - at deffn Command mkpart @var{part-type} [@var{fs-type}] @var{start} @var{end}
> > + at deffn Command mkpart [@var{part-type} @var{fs-type} @var{name}] @var{start} @var{end}
> >
> >  Creates a new partition, @emph{without} creating a new file system on
> >  that partition.  This is useful for creating partitions for file systems
> > @@ -684,8 +684,9 @@ partitions (i.e., non-extended partitions).  @var{start} and @var{end}
> >  are the offset from the beginning of the disk, that is, the ``distance''
> >  from the start of the disk.
> >
> > - at var{part-type} is one of: primary, extended, logical.  Extended and
> > -logical are only used for msdos and dvh disk labels.
> > + at var{part-type} is one of: primary, extended, logical.  These must only be
> > +used with msdos and dvh disk labels. @var{name} must be used with gpt disk
> > +labels. @var{part-type} and @var{name} must not be used with sun disk labels.
> >
> >  @var{fs-type} must be on of these supported file systems:
> >  @itemize @bullet
> 
> Thanks.
> I'm folding in this change:
> 
> diff --git a/doc/parted.texi b/doc/parted.texi
> index 8b88453..fdb9af3 100644
> --- a/doc/parted.texi
> +++ b/doc/parted.texi
> @@ -684,11 +684,13 @@ partitions (i.e., non-extended partitions).  @var{start} and @var{end}
>  are the offset from the beginning of the disk, that is, the ``distance''
>  from the start of the disk.
> 
> - at var{part-type} is one of: primary, extended, logical.  These must only be
> -used with msdos and dvh disk labels. @var{name} must be used with gpt disk
> -labels. @var{part-type} and @var{name} must not be used with sun disk labels.
> + at var{part-type} is one of @samp{primary}, @samp{extended} or @samp{logical},
> +and may be specified only with @samp{msdos} or @samp{dvh} partition tables.
> +A @var{name} must be specified for a @samp{gpt} partition table.
> +Neither @var{part-type} nor @var{name} may be used with a @samp{sun}
> +partition table.

Looks ok.

> 
> - at var{fs-type} must be on of these supported file systems:
> + at var{fs-type} must be one of these supported file systems:
>  @itemize @bullet
>  @item ext2
>  @item fat16, fat32

-- 
Joel Andres Granados
Brno, Czech Republic, Red Hat.