[pacman-dev] [PATCH] manpage example updates

[Xavier Chantry]

On Mon, Jun 14, 2010 at 1:23 PM, Nico Schottelius
<nico-pacman-dev at schottelius.org> wrote:
> From: Nico Schottelius <nico at kr.ethz.ch>
>
> Signed-off-by: Nico Schottelius <nico at kr.ethz.ch>
> ---
>  doc/makepkg.8.txt |   16 ++++++++++++++++
>  doc/pacman.8.txt  |   19 +++++++++++++++++++
>  2 files changed, 35 insertions(+), 0 deletions(-)
>
> diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
> index a2fdb3f..da8d750 100644
> --- a/doc/makepkg.8.txt
> +++ b/doc/makepkg.8.txt
> @@ -187,6 +187,22 @@ Environment Variables
>        corresponding value defined in linkman:makepkg.conf[5].
>
>
> +Examples
> +--------
> +To create a new package from scratch and let makepkg handle integrity checks:
> +
> +   $ mkdir mypkg
> +   $ cd mypkg
> +   # create PKGBUILD
> +   $ makepkg -g >> PKGBUILD
> +   $ makepkg
> +
> +Files
> +-----
> +PKGBUILD::
> +       Package build description file in the *current* directory.
> +
> +
>  Configuration
>  -------------
>  See linkman:makepkg.conf[5] for more details on configuring makepkg using the
> diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
> index 3d14a42..febb802 100644
> --- a/doc/pacman.8.txt
> +++ b/doc/pacman.8.txt
> @@ -415,6 +415,25 @@ original=X, current=Y, new=Z::
>        necessary changes into the original file.
>
>
> +Examples
> +--------
> +
> +pacman -Ss <'regexp'>::
> +       Search for regexp in package database.
> +
> +pacman -S <'packages'>::
> +       Download and install packages including dependencies.
> +
> +pacman -U <'paths'>::
> +       Install package found in the specified file(s).
> +
> +pacman -Syu::
> +       Update package list and upgrade all packages afterwards.
> +
> +pacman -Scc::
> +       Remove *all* packages from cache (-Sc removes only uninstalled ones).
> +
> +

That looks good to me.
I am just wondering if instead of <'regexp'> <'packages'> <'paths'> ,
we want to put specific examples there.
Just to increase the differences between general descriptions and
examples section.
What do you think ?