aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2020-07-28 20:24:24 +0200
committerMichael Muré <batolettre@gmail.com>2020-07-28 20:24:24 +0200
commitae5c0967cec40a7dcf9804ff592a4d15f1b26569 (patch)
tree7c1ba7626fd8158be030876d44ba55daf465d694 /doc/man
parent51c887ff9dd4f2a5f65d2d3de57f8a7729b1010d (diff)
downloadgit-bug-ae5c0967cec40a7dcf9804ff592a4d15f1b26569.tar.gz
commands: cleanup the command's usage to avoid warnings when generating the doc
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/git-bug-bridge-auth-add-token.12
-rw-r--r--doc/man/git-bug-bridge-auth-rm.12
-rw-r--r--doc/man/git-bug-bridge-pull.12
-rw-r--r--doc/man/git-bug-bridge-push.12
-rw-r--r--doc/man/git-bug-bridge-rm.12
-rw-r--r--doc/man/git-bug-commands.12
-rw-r--r--doc/man/git-bug-comment-add.12
-rw-r--r--doc/man/git-bug-comment.12
-rw-r--r--doc/man/git-bug-label-add.12
-rw-r--r--doc/man/git-bug-label-rm.12
-rw-r--r--doc/man/git-bug-label.12
-rw-r--r--doc/man/git-bug-ls-id.12
-rw-r--r--doc/man/git-bug-ls.12
-rw-r--r--doc/man/git-bug-pull.12
-rw-r--r--doc/man/git-bug-push.12
-rw-r--r--doc/man/git-bug-rm.128
-rw-r--r--doc/man/git-bug-select.14
-rw-r--r--doc/man/git-bug-show.12
-rw-r--r--doc/man/git-bug-status-close.12
-rw-r--r--doc/man/git-bug-status-open.12
-rw-r--r--doc/man/git-bug-status.12
-rw-r--r--doc/man/git-bug-title-edit.12
-rw-r--r--doc/man/git-bug-title.12
-rw-r--r--doc/man/git-bug-user-adopt.12
-rw-r--r--doc/man/git-bug-user.12
-rw-r--r--doc/man/git-bug.12
26 files changed, 54 insertions, 26 deletions
diff --git a/doc/man/git-bug-bridge-auth-add-token.1 b/doc/man/git-bug-bridge-auth-add-token.1
index fe4750b4..d522f0c7 100644
--- a/doc/man/git-bug-bridge-auth-add-token.1
+++ b/doc/man/git-bug-bridge-auth-add-token.1
@@ -9,7 +9,7 @@ git\-bug\-bridge\-auth\-add\-token \- Store a new token
.SH SYNOPSIS
.PP
-\fBgit\-bug bridge auth add\-token [] [flags]\fP
+\fBgit\-bug bridge auth add\-token [TOKEN] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-bridge-auth-rm.1 b/doc/man/git-bug-bridge-auth-rm.1
index 9ddac3f2..f2a9408a 100644
--- a/doc/man/git-bug-bridge-auth-rm.1
+++ b/doc/man/git-bug-bridge-auth-rm.1
@@ -9,7 +9,7 @@ git\-bug\-bridge\-auth\-rm \- Remove a credential.
.SH SYNOPSIS
.PP
-\fBgit\-bug bridge auth rm [flags]\fP
+\fBgit\-bug bridge auth rm ID [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-bridge-pull.1 b/doc/man/git-bug-bridge-pull.1
index 4a9e78db..12d12438 100644
--- a/doc/man/git-bug-bridge-pull.1
+++ b/doc/man/git-bug-bridge-pull.1
@@ -9,7 +9,7 @@ git\-bug\-bridge\-pull \- Pull updates.
.SH SYNOPSIS
.PP
-\fBgit\-bug bridge pull [] [flags]\fP
+\fBgit\-bug bridge pull [NAME] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-bridge-push.1 b/doc/man/git-bug-bridge-push.1
index 59e60bdf..c15cce60 100644
--- a/doc/man/git-bug-bridge-push.1
+++ b/doc/man/git-bug-bridge-push.1
@@ -9,7 +9,7 @@ git\-bug\-bridge\-push \- Push updates.
.SH SYNOPSIS
.PP
-\fBgit\-bug bridge push [] [flags]\fP
+\fBgit\-bug bridge push [NAME] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-bridge-rm.1 b/doc/man/git-bug-bridge-rm.1
index 8cfa925a..70ca410f 100644
--- a/doc/man/git-bug-bridge-rm.1
+++ b/doc/man/git-bug-bridge-rm.1
@@ -9,7 +9,7 @@ git\-bug\-bridge\-rm \- Delete a configured bridge.
.SH SYNOPSIS
.PP
-\fBgit\-bug bridge rm [flags]\fP
+\fBgit\-bug bridge rm NAME [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-commands.1 b/doc/man/git-bug-commands.1
index b7c1e214..28fabca5 100644
--- a/doc/man/git-bug-commands.1
+++ b/doc/man/git-bug-commands.1
@@ -9,7 +9,7 @@ git\-bug\-commands \- Display available commands.
.SH SYNOPSIS
.PP
-\fBgit\-bug commands [\&...] [flags]\fP
+\fBgit\-bug commands [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-comment-add.1 b/doc/man/git-bug-comment-add.1
index 530101b8..c1d13aa2 100644
--- a/doc/man/git-bug-comment-add.1
+++ b/doc/man/git-bug-comment-add.1
@@ -9,7 +9,7 @@ git\-bug\-comment\-add \- Add a new comment to a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug comment add [] [flags]\fP
+\fBgit\-bug comment add [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-comment.1
index 9beb7a06..7d46258d 100644
--- a/doc/man/git-bug-comment.1
+++ b/doc/man/git-bug-comment.1
@@ -9,7 +9,7 @@ git\-bug\-comment \- Display or add comments to a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug comment [] [flags]\fP
+\fBgit\-bug comment [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-label-add.1 b/doc/man/git-bug-label-add.1
index 86a4bb24..a11cdbe7 100644
--- a/doc/man/git-bug-label-add.1
+++ b/doc/man/git-bug-label-add.1
@@ -9,7 +9,7 @@ git\-bug\-label\-add \- Add a label to a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug label add [] [...] [flags]\fP
+\fBgit\-bug label add [ID] LABEL... [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-label-rm.1 b/doc/man/git-bug-label-rm.1
index e7e912ea..58dcccec 100644
--- a/doc/man/git-bug-label-rm.1
+++ b/doc/man/git-bug-label-rm.1
@@ -9,7 +9,7 @@ git\-bug\-label\-rm \- Remove a label from a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug label rm [] [...] [flags]\fP
+\fBgit\-bug label rm [ID] LABEL... [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-label.1 b/doc/man/git-bug-label.1
index 23fc0047..f5a47c5c 100644
--- a/doc/man/git-bug-label.1
+++ b/doc/man/git-bug-label.1
@@ -9,7 +9,7 @@ git\-bug\-label \- Display, add or remove labels to/from a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug label [] [flags]\fP
+\fBgit\-bug label [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-ls-id.1 b/doc/man/git-bug-ls-id.1
index c7b40114..d35415b4 100644
--- a/doc/man/git-bug-ls-id.1
+++ b/doc/man/git-bug-ls-id.1
@@ -9,7 +9,7 @@ git\-bug\-ls\-id \- List bug identifiers.
.SH SYNOPSIS
.PP
-\fBgit\-bug ls\-id [] [flags]\fP
+\fBgit\-bug ls\-id [PREFIX] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-ls.1
index 54a64cd2..2e6e0b63 100644
--- a/doc/man/git-bug-ls.1
+++ b/doc/man/git-bug-ls.1
@@ -9,7 +9,7 @@ git\-bug\-ls \- List bugs.
.SH SYNOPSIS
.PP
-\fBgit\-bug ls [] [flags]\fP
+\fBgit\-bug ls [QUERY] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-pull.1 b/doc/man/git-bug-pull.1
index 82b741ed..aed5a844 100644
--- a/doc/man/git-bug-pull.1
+++ b/doc/man/git-bug-pull.1
@@ -9,7 +9,7 @@ git\-bug\-pull \- Pull bugs update from a git remote.
.SH SYNOPSIS
.PP
-\fBgit\-bug pull [] [flags]\fP
+\fBgit\-bug pull [REMOTE] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-push.1 b/doc/man/git-bug-push.1
index dc694258..19a90cfc 100644
--- a/doc/man/git-bug-push.1
+++ b/doc/man/git-bug-push.1
@@ -9,7 +9,7 @@ git\-bug\-push \- Push bugs update to a git remote.
.SH SYNOPSIS
.PP
-\fBgit\-bug push [] [flags]\fP
+\fBgit\-bug push [REMOTE] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-rm.1 b/doc/man/git-bug-rm.1
new file mode 100644
index 00000000..8989c2ff
--- /dev/null
+++ b/doc/man/git-bug-rm.1
@@ -0,0 +1,28 @@
+.nh
+.TH GIT\-BUG(1)Apr 2019
+Generated from git\-bug's source code
+
+.SH NAME
+.PP
+git\-bug\-rm \- Remove an existing bug.
+
+
+.SH SYNOPSIS
+.PP
+\fBgit\-bug rm ID [flags]\fP
+
+
+.SH DESCRIPTION
+.PP
+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.
+
+
+.SH OPTIONS
+.PP
+\fB\-h\fP, \fB\-\-help\fP[=false]
+ help for rm
+
+
+.SH SEE ALSO
+.PP
+\fBgit\-bug(1)\fP
diff --git a/doc/man/git-bug-select.1 b/doc/man/git-bug-select.1
index 4df61221..47d46fe1 100644
--- a/doc/man/git-bug-select.1
+++ b/doc/man/git-bug-select.1
@@ -9,7 +9,7 @@ git\-bug\-select \- Select a bug for implicit use in future commands.
.SH SYNOPSIS
.PP
-\fBgit\-bug select [flags]\fP
+\fBgit\-bug select ID [flags]\fP
.SH DESCRIPTION
@@ -17,7 +17,7 @@ git\-bug\-select \- Select a bug for implicit use in future commands.
Select a bug for implicit use in future commands.
.PP
-This command allows you to omit any bug argument, for example:
+This command allows you to omit any bug ID argument, for example:
git bug show
instead of
git bug show 2f153ca
diff --git a/doc/man/git-bug-show.1 b/doc/man/git-bug-show.1
index eb694dac..6aca9063 100644
--- a/doc/man/git-bug-show.1
+++ b/doc/man/git-bug-show.1
@@ -9,7 +9,7 @@ git\-bug\-show \- Display the details of a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug show [] [flags]\fP
+\fBgit\-bug show [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-status-close.1 b/doc/man/git-bug-status-close.1
index 539c5447..2caeb8f5 100644
--- a/doc/man/git-bug-status-close.1
+++ b/doc/man/git-bug-status-close.1
@@ -9,7 +9,7 @@ git\-bug\-status\-close \- Mark a bug as closed.
.SH SYNOPSIS
.PP
-\fBgit\-bug status close [] [flags]\fP
+\fBgit\-bug status close [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-status-open.1 b/doc/man/git-bug-status-open.1
index d7aca0d0..950574ff 100644
--- a/doc/man/git-bug-status-open.1
+++ b/doc/man/git-bug-status-open.1
@@ -9,7 +9,7 @@ git\-bug\-status\-open \- Mark a bug as open.
.SH SYNOPSIS
.PP
-\fBgit\-bug status open [] [flags]\fP
+\fBgit\-bug status open [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-status.1 b/doc/man/git-bug-status.1
index df013911..22c31a3a 100644
--- a/doc/man/git-bug-status.1
+++ b/doc/man/git-bug-status.1
@@ -9,7 +9,7 @@ git\-bug\-status \- Display or change a bug status.
.SH SYNOPSIS
.PP
-\fBgit\-bug status [] [flags]\fP
+\fBgit\-bug status [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-title-edit.1 b/doc/man/git-bug-title-edit.1
index c1903854..99f4de86 100644
--- a/doc/man/git-bug-title-edit.1
+++ b/doc/man/git-bug-title-edit.1
@@ -9,7 +9,7 @@ git\-bug\-title\-edit \- Edit a title of a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug title edit [] [flags]\fP
+\fBgit\-bug title edit [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-title.1 b/doc/man/git-bug-title.1
index e3345acd..9d7deb0e 100644
--- a/doc/man/git-bug-title.1
+++ b/doc/man/git-bug-title.1
@@ -9,7 +9,7 @@ git\-bug\-title \- Display or change a title of a bug.
.SH SYNOPSIS
.PP
-\fBgit\-bug title [] [flags]\fP
+\fBgit\-bug title [ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-user-adopt.1 b/doc/man/git-bug-user-adopt.1
index 2be2afcb..6a53b36c 100644
--- a/doc/man/git-bug-user-adopt.1
+++ b/doc/man/git-bug-user-adopt.1
@@ -9,7 +9,7 @@ git\-bug\-user\-adopt \- Adopt an existing identity as your own.
.SH SYNOPSIS
.PP
-\fBgit\-bug user adopt [flags]\fP
+\fBgit\-bug user adopt USER\-ID [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug-user.1 b/doc/man/git-bug-user.1
index 5a4cf439..a454b56c 100644
--- a/doc/man/git-bug-user.1
+++ b/doc/man/git-bug-user.1
@@ -9,7 +9,7 @@ git\-bug\-user \- Display or change the user identity.
.SH SYNOPSIS
.PP
-\fBgit\-bug user [] [flags]\fP
+\fBgit\-bug user [USER\-ID] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1
index b9e5d758..ecb35feb 100644
--- a/doc/man/git-bug.1
+++ b/doc/man/git-bug.1
@@ -30,4 +30,4 @@ the same git remote you are already using to collaborate with other people.
.SH SEE ALSO
.PP
-\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-bridge(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-deselect(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-ls\-id(1)\fP, \fBgit\-bug\-ls\-label(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-select(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-status(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-title(1)\fP, \fBgit\-bug\-user(1)\fP, \fBgit\-bug\-version(1)\fP, \fBgit\-bug\-webui(1)\fP
+\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-bridge(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-deselect(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-ls\-id(1)\fP, \fBgit\-bug\-ls\-label(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-rm(1)\fP, \fBgit\-bug\-select(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-status(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-title(1)\fP, \fBgit\-bug\-user(1)\fP, \fBgit\-bug\-version(1)\fP, \fBgit\-bug\-webui(1)\fP