[pacman-dev] [PATCH 2/2] Improve documentation of -k/--dbonly

[Dan McGee]

We had the long option wrong in some places and its behavior wasn't
documented at all with regards to -U/--upgrade.

Signed-off-by: Dan McGee <dan at archlinux.org>
---
 doc/pacman.8.txt    |   15 ++++++++++++---
 src/pacman/pacman.c |    3 ++-
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
index 249923a..3d14a42 100644
--- a/doc/pacman.8.txt
+++ b/doc/pacman.8.txt
@@ -90,8 +90,9 @@ to determine which packages need upgrading. This behavior operates as follows:
 *-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 <<HCF,Handling Config
-	Files>> for an explanation on how pacman takes care of config files.
+	specified. This is a ``remove-then-add'' process. See <<UO,Upgrade
+	Options>> below; also see <<HCF,Handling Config Files>> for an explanation
+	on how pacman takes care of config files.
 
 *-V, \--version*::
 	Display version and exit.
@@ -273,7 +274,7 @@ Remove Options[[RO]]
 	or more target packages. This operation is recursive, and must be used
 	with care since it can remove many potentially needed packages.
 
-*-k, \--keep*::
+*-k, \--dbonly*::
 	Removes the database entry only. Leaves all files in place.
 
 *-n, \--nosave*::
@@ -375,6 +376,14 @@ linkman:pacman.conf[5].
 	separating them with a comma.
 
 
+Upgrade Options[[UO]]
+--------------------
+*-k, \--dbonly*::
+	Adds the database entries for the specified packages but do not install any
+	of the files. On an upgrade operation, the existing package and all files
+	will be removed and the database entry for the new package will be added.
+
+
 Handling Config Files[[HCF]]
 ----------------------------
 Pacman uses the same logic as rpm to determine action against files that are
diff --git a/src/pacman/pacman.c b/src/pacman/pacman.c
index 7461b6b..09a8105 100644
--- a/src/pacman/pacman.c
+++ b/src/pacman/pacman.c
@@ -90,7 +90,7 @@ static void usage(int op, const char * const myname)
 			printf("%s:\n", str_opt);
 			printf(_("  -c, --cascade        remove packages and all packages that depend on them\n"));
 			printf(_("  -d, --nodeps         skip dependency checks\n"));
-			printf(_("  -k, --dbonly         only remove database entry, do not remove files\n"));
+			printf(_("  -k, --dbonly         only remove database entries, do not remove files\n"));
 			printf(_("  -n, --nosave         remove configuration files as well\n"));
 			printf(_("  -s, --recursive      remove dependencies also (that won't break packages)\n"
 				 "                       (-ss includes explicitly installed dependencies too)\n"));
@@ -105,6 +105,7 @@ static void usage(int op, const char * const myname)
 			printf(_("      --asexplicit     install packages as explicitly installed\n"));
 			printf(_("  -d, --nodeps         skip dependency checks\n"));
 			printf(_("  -f, --force          force install, overwrite conflicting files\n"));
+			printf(_("  -k, --dbonly         add database entries, do not install or keep existing files\n"));
 			printf(_("      --print          only print the targets instead of performing the operation\n"));
 			printf(_("      --print-format <string>\n"
 			         "                       specify how the targets should be printed\n"));
-- 
1.7.1