[pacman-dev] [PATCH] manpage example updates

2010-06-14 Thread Nico Schottelius
From: Nico Schottelius n...@kr.ethz.ch

Signed-off-by: Nico Schottelius n...@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).
+
+
 Configuration
 -
 See linkman:pacman.conf[5] for more details on configuring pacman using the
-- 
1.7.1




Re: [pacman-dev] [PATCH] manpage example updates

2010-06-14 Thread Xavier Chantry
On Mon, Jun 14, 2010 at 1:23 PM, Nico Schottelius
nico-pacman-...@schottelius.org wrote:
 From: Nico Schottelius n...@kr.ethz.ch

 Signed-off-by: Nico Schottelius n...@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 ?



Re: [pacman-dev] [PATCH] manpage example updates

2010-06-14 Thread Nico Schottelius
Xavier Chantry [Mon, Jun 14, 2010 at 01:45:33PM +0200]:
 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 ?

You're absolutely right, they are examples and should not be
possible examples, but real world examples. Patch sent.

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/ ...


pgpMI3fenatPc.pgp
Description: PGP signature