[pacman-dev] [PATCH 1/2] add two entries to pacman manpage examples section

[Nico Schottelius]

Xavier Chantry [Sun, Jun 13, 2010 at 03:36:08PM +0200]:
> On Sun, Jun 13, 2010 at 3:28 PM, Nico Schottelius
> <nico-pacman-dev at schottelius.org> wrote:
> >
> > Signed-off-by: Nico Schottelius <nico at kr.ethz.ch>
> > ---
> >  doc/pacman.8.txt |   10 ++++++++++
> >  1 files changed, 10 insertions(+), 0 deletions(-)
> >
> >
> 
> Not inline, but ok, I will just copy/paste below :)

Seems --inline to git send-email wasn't the right then :-/

> +Examples
> +--------
> +
> +pacman -Syu::
> +	Update package list and upgrade all packages afterwards.
> +
> 
> Yeah this is typically the important commands that are not obvious
> when just quickly browsing the man page.
> But as I said, it's already covered in the wiki :
> http://wiki.archlinux.org/index.php/Pacman#Upgrading_packages

Understood. I'm probably stopping my effort right here, if it's
agreed that the wiki is the primary documentation for pacman.

I'm probably thinking in different context than the typical archlinux-dev,
for me it's important software can be re-used at other places and thus
I don't think putting "how to get used to tool x" information into a
distribution wiki is a great idea.

But again, it may be that my thinking way is not compatible to what
you prefer here.

> +pacman -U <'path'>::
> +	Install package found in the specified file.
> +
> 
> This one looks like the abstract description we already have, just shorter :
>        -U, --upgrade
>            Upgrade or add package(s) to the system and install the
> required dependencies from sync repos.
>            Either a URL or file path can be specified. This is a
> “remove-then-add” process. See Upgrade
>            Options below; also see Handling Config Files for an
> explanation on how pacman takes care of
>            config files.

It is indeed. But if I want to find out
"how to install a package from a file", I will go to the examples section
instead of reading the whole manpage at first.

Nico

-- 
New PGP key: 7ED9 F7D3 6B10 81D7 0EC5  5C09 D7DC C8E4 3187 7DF0
Please resign, if you signed 9885188C or 8D0E27A4.

Currently moving *.schottelius.org to http://www.nico.schottelius.org/ ...
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: not available
URL: <http://mailman.archlinux.org/pipermail/pacman-dev/attachments/20100613/073a878a/attachment.bin>