[Intel-gfx] [dim PATCH 2/2] dim: document how to define subcommand aliases
Jani Nikula
jani.nikula at intel.com
Tue Jan 31 09:42:30 UTC 2017
Cc: Gerd Hoffmann <kraxel at redhat.com>
Signed-off-by: Jani Nikula <jani.nikula at intel.com>
---
dim.rst | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/dim.rst b/dim.rst
index 97b375e34e90..911b4666b4aa 100644
--- a/dim.rst
+++ b/dim.rst
@@ -330,9 +330,10 @@ Run the given command in all active workdirs including the main repository under
list-aliases
------------
-
List all aliases for the subcommand names. Useful for autocompletion scripts.
+See \$dim_alias_<alias> under ENVIRONMENT below on how to define aliases.
+
list-branches
-------------
@@ -401,6 +402,14 @@ DIM_TEMPLATE_SIGNATURE
----------------------
Path to a file containing a signature template for pull request mails.
+dim_alias_<alias>
+-----------------
+Make **<alias>** an alias for the subcommand defined as the value. For example,
+`dim_alias_ub=update-branches`. There are some built-in aliases. Aliases can be
+listed using the **list-aliases** subcommand.
+
+The alias functionality requires **bash(1)** version 4.3 or later to work.
+
CONTRIBUTING
============
--
2.1.4
More information about the Intel-gfx
mailing list