From 1c13ae4ed5d84b32c2c1a0698f9e688c312de989 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Mon, 11 Jan 2016 15:14:32 +0200
Subject: Documentation improvements

---
 bpkg/pkg-drop.cli | 47 ++++++++++++++++++++++++++---------------------
 1 file changed, 26 insertions(+), 21 deletions(-)

(limited to 'bpkg/pkg-drop.cli')

diff --git a/bpkg/pkg-drop.cli b/bpkg/pkg-drop.cli
index 6ec7130..7737d15 100644
--- a/bpkg/pkg-drop.cli
+++ b/bpkg/pkg-drop.cli
@@ -6,29 +6,34 @@ include <bpkg/configuration.cli>;
 
 "\section=1"
 "\name=bpkg-pkg-drop"
-"\summary=drop one or more packages"
+"\summary=drop package"
 
-/*
-"\h{SYNOPSIS}
+namespace bpkg
+{
+  {
+    "<options>",
 
-bpkg pkg-drop [<options>] <pkg>..."
+    "\h|SYNOPSIS|
 
-"\h{DESCRIPTION}
+     \c{\b{bpkg pkg-drop}|\b{drop} [<options>] <pkg>...}
 
-The \cb{pkg-drop} command drops one or more packages from the configuration.
-If the packages being dropped still have dependents, then those will have
-to be drop as well and you will be prompted for a confirmation. Similarly,
-if the packages being dropped have prerequisites that are no longer needed,
-you will be offered to drop those as well.
+     \h|DESCRIPTION|
 
-The \cb{pkg-drop} command also supports several \cb{--*-only} options that
-allow you to limit the amount of work that will be done.
-*/
+     The \cb{pkg-drop} command drops one or more packages from the
+     configuration. If the packages being dropped still have dependent
+     packages, then those will have to be drop as well and you will be prompted
+     to confirm. Similarly, if the packages being dropped have prerequisite
+     packages that would otherwise no longer be needed, you will be offered to
+     drop those as well.
+
+     The \cb{pkg-drop} command also supports several \cb{--*-only} options that
+     allow you to limit the amount of work that will be done."
+  }
 
-namespace bpkg
-{
   class pkg_drop_options: configuration_options
   {
+    "\h|PKG-DROP OPTIONS|"
+
     bool --yes|-y
     {
       "Assume the answer to all prompts is \cb{yes}. Note that this option
@@ -44,19 +49,19 @@ namespace bpkg
 
     bool --drop-dependent
     {
-      "Don't warn about or ask for confirmation of dropping dependent
+      "Don't warn about or ask for confirmation if dropping dependent
        packages."
     }
 
-    bool --disfigure-only
-    {
-      "Disfigure all the packages but don't purge."
-    }
-
     bool --print-only|-p
     {
       "Print to \cb{STDOUT} what would be done without actually doing
        anything."
     }
+
+    bool --disfigure-only
+    {
+      "Disfigure all the packages but don't purge."
+    }
   };
 }
-- 
cgit v1.1