richardphibel / rpms / dnf

Forked from rpms/dnf 2 years ago
Clone
Blob Blame History Raw
From 3a332e3eba6230d7da7472db654d50b8070570d8 Mon Sep 17 00:00:00 2001
From: Pavla Kratochvilova <pkratoch@redhat.com>
Date: Thu, 23 May 2019 11:07:37 +0200
Subject: [PATCH] [doc] Explain the backslash notation also near the example
 (RhBug:1680482)

https://bugzilla.redhat.com/show_bug.cgi?id=1680482
The backslash notation is mentioned before, but this adds an explanation
directly to the example where it is used.
---
 doc/command_ref.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/command_ref.rst b/doc/command_ref.rst
index ba22453055..84bad4b2b3 100644
--- a/doc/command_ref.rst
+++ b/doc/command_ref.rst
@@ -454,10 +454,12 @@ Alias Examples
     Lists all defined aliases.
 
 ``dnf alias add rm=remove``
-    Adds new alias command called "rm" which does the same thing as the command "remove".
+    Adds a new command alias called ``rm`` which works the same as the ``remove`` command.
 
 ``dnf alias add update="\update --skip-broken --disableexcludes=all --obsoletes"``
-    Adds new alias command called "update" which does the same thing as the command "update", but with options ``--skip-broken --disableexcludes=all --obsoletes``.
+    Adds a new command alias called ``update`` which works the same as the ``update`` command,
+    with additional options. Note that the original ``update`` command is prefixed with a ``\``
+    to prevent an infinite loop in alias processing.
 
 .. _alias_processing_examples-label: