From de42ef701fe83334111c43c43662294c8019b5e5 Mon Sep 17 00:00:00 2001
From: Micah Abbott <miabbott@redhat.com>
Date: Tue, 5 Jun 2018 09:51:01 -0400
Subject: [PATCH] docs: improve install/uninstall help

This adds some additional help to the man page and the RTD page around
using local packages with the install/uninstall commands.

Closes: #1388
Approved by: cgwalters
---
 docs/manual/administrator-handbook.md | 9 +++++++--
 man/rpm-ostree.xml                    | 8 +++++++-
 2 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/docs/manual/administrator-handbook.md b/docs/manual/administrator-handbook.md
index b08f4d8c..c1fa2651 100644
--- a/docs/manual/administrator-handbook.md
+++ b/docs/manual/administrator-handbook.md
@@ -65,8 +65,13 @@ to use packages where it suits.
 ```
 
 Will download the target package, its dependencies, and create a new deployment
-with those packages installed.  To remove layered packages, use `rpm-ostree
-uninstall`.
+with those packages installed.  It is also possible to specify a local package
+which is not part of a repository.
+
+To remove layered packages installed from a repository, use `rpm-ostree uninstall
+<pkg>`.  To remove layered packages installed from a local package, you must
+specify the full NEVRA of the package.  For example, `rpm-ostree uninstall
+ltrace-0.7.91-16.fc22.x86_64`.
 
 By default, every `rpm-ostree` operation is "offline" - it has no effect
 on your running system, and will only take effect when you reboot.  This "pending" state is
diff --git a/man/rpm-ostree.xml b/man/rpm-ostree.xml
index 66bc1a91..70a87597 100644
--- a/man/rpm-ostree.xml
+++ b/man/rpm-ostree.xml
@@ -221,7 +221,8 @@ Boston, MA 02111-1307, USA.
             Takes one or more packages as arguments. The packages are
             fetched from the enabled repositories in
             <filename>/etc/yum.repos.d/</filename> and are overlayed on
-            top of a new deployment.
+            top of a new deployment.  It is also possible to specify a
+            local package that resides on the host.
           </para>
 
           <para>
@@ -264,6 +265,11 @@ Boston, MA 02111-1307, USA.
             top of a new deployment.
           </para>
 
+          <para>When trying to uninstall a package that was installed
+            from a local RPM (i.e. not from a repository), you must
+            specify the full NEVRA of the package.
+          </para>
+
           <para>
             <command>--reboot</command> or <command>-r</command> to
             initiate a reboot after the deployment is prepared.