From 660d9d660e3e8047fb1379e1d656472dcf6d4202 Mon Sep 17 00:00:00 2001
From: Michael Pyne <mpyne@kde.org>
Date: Mon, 25 Jul 2005 02:45:43 +0000
Subject: [PATCH] Add documentation for the recently added --quiet option.

Also, make --dry-run an alias for --pretend since --dry-run seems to be a
common name for that type of option.

BUG:109501

svn path=/trunk/KDE/kdesdk/doc/scripts/kdesvn-build/; revision=438341
---
 doc/index.docbook | 24 +++++++++++++++++++++++-
 kdesvn-build      | 40 +++++++++++++++++++++++++++++++---------
 2 files changed, 54 insertions(+), 10 deletions(-)

diff --git a/doc/index.docbook b/doc/index.docbook
index ce1b4fd..0de5267 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1112,6 +1112,28 @@ don't actually DO anything, but act like you did.
 </para></listitem>
 </varlistentry>
 
+<varlistentry id="cmdline-quiet">
+<term><option>--quiet</option> (or <option>-q</option>)</term>
+<listitem><para>
+Don't be as noisy with the output.  With this switch only the basics are
+output.
+</para></listitem>
+</varlistentry>
+
+<varlistentry id="cmdline-really-quiet">
+<term><option>--really-quiet</option></term>
+<listitem><para>
+Only output warnings and errors.
+</para></listitem>
+</varlistentry>
+
+<varlistentry id="cmdline-verbose">
+<term><option>--verbose</option></term>
+<listitem><para>
+Be very descriptive about what's going on, and what kdesvn-build is doing.
+</para></listitem>
+</varlistentry>
+
 <varlistentry id="cmdline-svn-only">
 <term><option>--svn-only</option></term>
 <listitem><para>
@@ -1129,7 +1151,7 @@ only perform the build process.
 <varlistentry id="cmdline-ignore-modules">
 <term><option>--ignore-modules</option></term>
 <listitem><para>
-don't including the modules passed on the rest of the command line in the update/build
+don't include the modules passed on the rest of the command line in the update/build
 process.
 </para></listitem>
 </varlistentry>
diff --git a/kdesvn-build b/kdesvn-build
index 4c13a1b..48d2c42 100755
--- a/kdesvn-build
+++ b/kdesvn-build
@@ -64,6 +64,20 @@ This utility is part of the KDE Software Development Kit.
 
 =over
 
+=item B<--quiet>,  B<-q>
+
+With this switch kdesvn-build will only output a general overview of the build
+process.  Progress output is still displayed if available.
+
+=item B<--really-quiet>
+
+With this switch only warnings and errors will be output.
+
+=item B<--verbose>,  B<-v>
+
+Be very detailed in what is going on, and what actions kdesvn-build is taking.
+Only B<--debug> is more detailed.
+
 =item B<--no-svn>
 
 Skip contacting the Subversion server.
@@ -1827,22 +1841,29 @@ Options:
     --no-build           Skip the build process.
     --no-install         Don't automatically install after build.
 
-    --svn-only           Update from Subversion only (Identical to --no-build at 
-                         this point).
+    --svn-only           Update from Subversion only (Identical to --no-build
+                         at this point).
     --build-only         Build only, don't perform updates or install.
 
-    --rc-file=<filename> Read configuration from filename instead of default.
-    --debug              Activates debug mode.
     --pretend (or -p)    Don't actually contact the Subversion server, run make,
                          or create/delete files and directories.  Instead,
                          output what the script would have done.
+    --quiet (or -q)      Be less descriptive of the build process, without
+                         printing each little substep kdesvn-build is
+                         performing.
+    --really-quiet       Only warnings and errors will be displayed.
+    --verbose (or -v)    Be *very* descriptive of the build process.  Only
+                         --debug outputs more.
+    --debug              Activates debug mode.
+    --color
+    --no-color           Add (or remove) color from the output.
+
+    --rc-file=<filename> Read configuration from filename instead of default.
     --nice=<value>       Allows you to run the script with a lower priority
                          The default value is 10 (lower priority by 10 steps).
     --prefix=/kde/path   This option is a shortcut to change the setting for
                          kdedir from the command line.  It implies
                          --reconfigure.
-    --color
-    --no-color           Add (or remove) color from the output.
 
     --resume             Tries to resume the make process from the last time
                          the script was run, without performing the Subversion
@@ -1863,8 +1884,9 @@ Options:
                          perform the build.
     --install            Try to install the packages passed on the command
                          line, or all packages in ~/.kdesvn-buildrc that don't
-                         have manual-build set.  Building and Subversion updates are
-                         not performed.
+                         have manual-build set.  Building and Subversion
+                         updates are not performed.
+
     --<option>=          Any unrecognized options are added to the global
                          configuration, overriding any value that may exist.
     --<module>,<option>= Likewise, this allows you to override any module
@@ -2036,7 +2058,7 @@ DONE
                 last SWITCH;
             };
 
-            /^(--pretend)|(-p)$/ && do {
+            /^(--dry-run)|(--pretend)|(-p)$/ && do {
                 set_option('global', '#pretend', 1);
                 last SWITCH;
             };