[pacman-dev] [PATCH] manpage update: add real world examples with full path

[Allan McRae]

On 14/06/10 23:15, Nico Schottelius wrote:
> From: Nico Schottelius<nico at kr.ethz.ch>
>
> Signed-off-by: Nico Schottelius<nico at kr.ethz.ch>
> ---
>   doc/makepkg.8.txt |   18 ++++++++++++++++++
>   doc/pacman.8.txt  |   19 +++++++++++++++++++
>   2 files changed, 37 insertions(+), 0 deletions(-)
>
> diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
> index a2fdb3f..ca99419 100644
> --- a/doc/makepkg.8.txt
> +++ b/doc/makepkg.8.txt
> @@ -187,6 +187,24 @@ 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
> +   $ cp /usr/share/pacman/PKGBUILD.proto PKGBUILD
> +   # edit PKGBUILD to your needs
> +   $ makepkg -g>>  PKGBUILD
> +   $ makepkg
> +
> +
> +Files
> +-----
> +PKGBUILD::
> +	Package build description file in the *current* directory.
> +
> +

Surely that is covered by "man PKGBUILD".

Anyway, I think the makepkg section is unnecessary...  here is why

allan at mugen ~
 > makepkg
==> ERROR: PKGBUILD does not exist.

What is a PKGBUILD?  There are heaps of links in "man makepkg" to a 
PKGBUILD man page so...

allan at mugen ~
 > man PKGBUILD

Now, that does not say where to find the prototypes, but I think it is 
the PKGBUILD man page that should be adjusted.  It also should be 
adjusted to remove reference to Arch.  But it does provide examples.

Also, the directory /usr/share/pacman is configurable, so should not be 
hard coded.

Allan