From ae5c0967cec40a7dcf9804ff592a4d15f1b26569 Mon Sep 17 00:00:00 2001
From: Michael Muré <batolettre@gmail.com>
Date: Tue, 28 Jul 2020 20:24:24 +0200
Subject: commands: cleanup the command's usage to avoid warnings when
 generating the doc

---
 doc/md/git-bug.md                       |  1 +
 doc/md/git-bug_bridge_auth_add-token.md |  2 +-
 doc/md/git-bug_bridge_auth_rm.md        |  2 +-
 doc/md/git-bug_bridge_pull.md           |  2 +-
 doc/md/git-bug_bridge_push.md           |  2 +-
 doc/md/git-bug_bridge_rm.md             |  2 +-
 doc/md/git-bug_commands.md              |  2 +-
 doc/md/git-bug_comment.md               |  2 +-
 doc/md/git-bug_comment_add.md           |  2 +-
 doc/md/git-bug_label.md                 |  2 +-
 doc/md/git-bug_label_add.md             |  2 +-
 doc/md/git-bug_label_rm.md              |  2 +-
 doc/md/git-bug_ls-id.md                 |  2 +-
 doc/md/git-bug_ls.md                    |  2 +-
 doc/md/git-bug_pull.md                  |  2 +-
 doc/md/git-bug_push.md                  |  2 +-
 doc/md/git-bug_rm.md                    | 22 ++++++++++++++++++++++
 doc/md/git-bug_select.md                |  4 ++--
 doc/md/git-bug_show.md                  |  2 +-
 doc/md/git-bug_status.md                |  2 +-
 doc/md/git-bug_status_close.md          |  2 +-
 doc/md/git-bug_status_open.md           |  2 +-
 doc/md/git-bug_title.md                 |  2 +-
 doc/md/git-bug_title_edit.md            |  2 +-
 doc/md/git-bug_user.md                  |  2 +-
 doc/md/git-bug_user_adopt.md            |  2 +-
 26 files changed, 48 insertions(+), 25 deletions(-)
 create mode 100644 doc/md/git-bug_rm.md

(limited to 'doc/md')

diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md
index 5a736f34..99b554e2 100644
--- a/doc/md/git-bug.md
+++ b/doc/md/git-bug.md
@@ -35,6 +35,7 @@ git-bug [flags]
 * [git-bug ls-label](git-bug_ls-label.md)	 - List valid labels.
 * [git-bug pull](git-bug_pull.md)	 - Pull bugs update from a git remote.
 * [git-bug push](git-bug_push.md)	 - Push bugs update to a git remote.
+* [git-bug rm](git-bug_rm.md)	 - Remove an existing bug.
 * [git-bug select](git-bug_select.md)	 - Select a bug for implicit use in future commands.
 * [git-bug show](git-bug_show.md)	 - Display the details of a bug.
 * [git-bug status](git-bug_status.md)	 - Display or change a bug status.
diff --git a/doc/md/git-bug_bridge_auth_add-token.md b/doc/md/git-bug_bridge_auth_add-token.md
index f0f8ac72..c6466522 100644
--- a/doc/md/git-bug_bridge_auth_add-token.md
+++ b/doc/md/git-bug_bridge_auth_add-token.md
@@ -7,7 +7,7 @@ Store a new token
 Store a new token
 
 ```
-git-bug bridge auth add-token [<token>] [flags]
+git-bug bridge auth add-token [TOKEN] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_bridge_auth_rm.md b/doc/md/git-bug_bridge_auth_rm.md
index 059aa43d..cf470c0c 100644
--- a/doc/md/git-bug_bridge_auth_rm.md
+++ b/doc/md/git-bug_bridge_auth_rm.md
@@ -7,7 +7,7 @@ Remove a credential.
 Remove a credential.
 
 ```
-git-bug bridge auth rm <id> [flags]
+git-bug bridge auth rm ID [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_bridge_pull.md b/doc/md/git-bug_bridge_pull.md
index fea92b85..784bf99c 100644
--- a/doc/md/git-bug_bridge_pull.md
+++ b/doc/md/git-bug_bridge_pull.md
@@ -7,7 +7,7 @@ Pull updates.
 Pull updates.
 
 ```
-git-bug bridge pull [<name>] [flags]
+git-bug bridge pull [NAME] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_bridge_push.md b/doc/md/git-bug_bridge_push.md
index 35436dd6..387270e2 100644
--- a/doc/md/git-bug_bridge_push.md
+++ b/doc/md/git-bug_bridge_push.md
@@ -7,7 +7,7 @@ Push updates.
 Push updates.
 
 ```
-git-bug bridge push [<name>] [flags]
+git-bug bridge push [NAME] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_bridge_rm.md b/doc/md/git-bug_bridge_rm.md
index 54941b2f..748011f2 100644
--- a/doc/md/git-bug_bridge_rm.md
+++ b/doc/md/git-bug_bridge_rm.md
@@ -7,7 +7,7 @@ Delete a configured bridge.
 Delete a configured bridge.
 
 ```
-git-bug bridge rm <name> [flags]
+git-bug bridge rm NAME [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_commands.md b/doc/md/git-bug_commands.md
index e1a409d2..00eef422 100644
--- a/doc/md/git-bug_commands.md
+++ b/doc/md/git-bug_commands.md
@@ -7,7 +7,7 @@ Display available commands.
 Display available commands.
 
 ```
-git-bug commands [<option>...] [flags]
+git-bug commands [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md
index 5a79cf6f..60c4ee88 100644
--- a/doc/md/git-bug_comment.md
+++ b/doc/md/git-bug_comment.md
@@ -7,7 +7,7 @@ Display or add comments to a bug.
 Display or add comments to a bug.
 
 ```
-git-bug comment [<id>] [flags]
+git-bug comment [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_comment_add.md b/doc/md/git-bug_comment_add.md
index 51114f7d..64bd840c 100644
--- a/doc/md/git-bug_comment_add.md
+++ b/doc/md/git-bug_comment_add.md
@@ -7,7 +7,7 @@ Add a new comment to a bug.
 Add a new comment to a bug.
 
 ```
-git-bug comment add [<id>] [flags]
+git-bug comment add [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_label.md b/doc/md/git-bug_label.md
index 5ac7c2e6..a847af3d 100644
--- a/doc/md/git-bug_label.md
+++ b/doc/md/git-bug_label.md
@@ -7,7 +7,7 @@ Display, add or remove labels to/from a bug.
 Display, add or remove labels to/from a bug.
 
 ```
-git-bug label [<id>] [flags]
+git-bug label [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_label_add.md b/doc/md/git-bug_label_add.md
index ee0a82ad..9900b52d 100644
--- a/doc/md/git-bug_label_add.md
+++ b/doc/md/git-bug_label_add.md
@@ -7,7 +7,7 @@ Add a label to a bug.
 Add a label to a bug.
 
 ```
-git-bug label add [<id>] <label>[...] [flags]
+git-bug label add [ID] LABEL... [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_label_rm.md b/doc/md/git-bug_label_rm.md
index b447f44d..fa6d1aa3 100644
--- a/doc/md/git-bug_label_rm.md
+++ b/doc/md/git-bug_label_rm.md
@@ -7,7 +7,7 @@ Remove a label from a bug.
 Remove a label from a bug.
 
 ```
-git-bug label rm [<id>] <label>[...] [flags]
+git-bug label rm [ID] LABEL... [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_ls-id.md b/doc/md/git-bug_ls-id.md
index 0117474c..134f3aec 100644
--- a/doc/md/git-bug_ls-id.md
+++ b/doc/md/git-bug_ls-id.md
@@ -7,7 +7,7 @@ List bug identifiers.
 List bug identifiers.
 
 ```
-git-bug ls-id [<prefix>] [flags]
+git-bug ls-id [PREFIX] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_ls.md
index 1532efab..e2721c72 100644
--- a/doc/md/git-bug_ls.md
+++ b/doc/md/git-bug_ls.md
@@ -9,7 +9,7 @@ Display a summary of each bugs.
 You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language or with flags.
 
 ```
-git-bug ls [<query>] [flags]
+git-bug ls [QUERY] [flags]
 ```
 
 ### Examples
diff --git a/doc/md/git-bug_pull.md b/doc/md/git-bug_pull.md
index 1519c87f..cf29e079 100644
--- a/doc/md/git-bug_pull.md
+++ b/doc/md/git-bug_pull.md
@@ -7,7 +7,7 @@ Pull bugs update from a git remote.
 Pull bugs update from a git remote.
 
 ```
-git-bug pull [<remote>] [flags]
+git-bug pull [REMOTE] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_push.md b/doc/md/git-bug_push.md
index 5e95ea2f..226bc951 100644
--- a/doc/md/git-bug_push.md
+++ b/doc/md/git-bug_push.md
@@ -7,7 +7,7 @@ Push bugs update to a git remote.
 Push bugs update to a git remote.
 
 ```
-git-bug push [<remote>] [flags]
+git-bug push [REMOTE] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_rm.md b/doc/md/git-bug_rm.md
new file mode 100644
index 00000000..3b77ce1c
--- /dev/null
+++ b/doc/md/git-bug_rm.md
@@ -0,0 +1,22 @@
+## git-bug rm
+
+Remove an existing bug.
+
+### Synopsis
+
+Remove an existing bug in the local repository. Note removing bugs that were imported from bridges will not remove the bug on the remote, and will only remove the local copy of the bug.
+
+```
+git-bug rm ID [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for rm
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bug tracker embedded in Git.
+
diff --git a/doc/md/git-bug_select.md b/doc/md/git-bug_select.md
index 6a851acb..b8a71120 100644
--- a/doc/md/git-bug_select.md
+++ b/doc/md/git-bug_select.md
@@ -6,7 +6,7 @@ Select a bug for implicit use in future commands.
 
 Select a bug for implicit use in future commands.
 
-This command allows you to omit any bug <id> argument, for example:
+This command allows you to omit any bug ID argument, for example:
   git bug show
 instead of
   git bug show 2f153ca
@@ -15,7 +15,7 @@ The complementary command is "git bug deselect" performing the opposite operatio
 
 
 ```
-git-bug select <id> [flags]
+git-bug select ID [flags]
 ```
 
 ### Examples
diff --git a/doc/md/git-bug_show.md b/doc/md/git-bug_show.md
index e6d2d7ba..1c6a4ab0 100644
--- a/doc/md/git-bug_show.md
+++ b/doc/md/git-bug_show.md
@@ -7,7 +7,7 @@ Display the details of a bug.
 Display the details of a bug.
 
 ```
-git-bug show [<id>] [flags]
+git-bug show [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_status.md b/doc/md/git-bug_status.md
index a04098e6..c2b380f3 100644
--- a/doc/md/git-bug_status.md
+++ b/doc/md/git-bug_status.md
@@ -7,7 +7,7 @@ Display or change a bug status.
 Display or change a bug status.
 
 ```
-git-bug status [<id>] [flags]
+git-bug status [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_status_close.md b/doc/md/git-bug_status_close.md
index 4978341f..97081b59 100644
--- a/doc/md/git-bug_status_close.md
+++ b/doc/md/git-bug_status_close.md
@@ -7,7 +7,7 @@ Mark a bug as closed.
 Mark a bug as closed.
 
 ```
-git-bug status close [<id>] [flags]
+git-bug status close [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_status_open.md b/doc/md/git-bug_status_open.md
index f6d03215..661508ad 100644
--- a/doc/md/git-bug_status_open.md
+++ b/doc/md/git-bug_status_open.md
@@ -7,7 +7,7 @@ Mark a bug as open.
 Mark a bug as open.
 
 ```
-git-bug status open [<id>] [flags]
+git-bug status open [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_title.md b/doc/md/git-bug_title.md
index cb326071..5c5698e0 100644
--- a/doc/md/git-bug_title.md
+++ b/doc/md/git-bug_title.md
@@ -7,7 +7,7 @@ Display or change a title of a bug.
 Display or change a title of a bug.
 
 ```
-git-bug title [<id>] [flags]
+git-bug title [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_title_edit.md b/doc/md/git-bug_title_edit.md
index edf44a1a..8119b8b5 100644
--- a/doc/md/git-bug_title_edit.md
+++ b/doc/md/git-bug_title_edit.md
@@ -7,7 +7,7 @@ Edit a title of a bug.
 Edit a title of a bug.
 
 ```
-git-bug title edit [<id>] [flags]
+git-bug title edit [ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_user.md b/doc/md/git-bug_user.md
index f2c783af..4fc0dd54 100644
--- a/doc/md/git-bug_user.md
+++ b/doc/md/git-bug_user.md
@@ -7,7 +7,7 @@ Display or change the user identity.
 Display or change the user identity.
 
 ```
-git-bug user [<user-id>] [flags]
+git-bug user [USER-ID] [flags]
 ```
 
 ### Options
diff --git a/doc/md/git-bug_user_adopt.md b/doc/md/git-bug_user_adopt.md
index 7bedace5..86682be0 100644
--- a/doc/md/git-bug_user_adopt.md
+++ b/doc/md/git-bug_user_adopt.md
@@ -7,7 +7,7 @@ Adopt an existing identity as your own.
 Adopt an existing identity as your own.
 
 ```
-git-bug user adopt <user-id> [flags]
+git-bug user adopt USER-ID [flags]
 ```
 
 ### Options
-- 
cgit