aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/man/git-bug-comment-add.14
-rw-r--r--doc/man/git-bug-comment.14
-rw-r--r--doc/man/git-bug-label-add.14
-rw-r--r--doc/man/git-bug-label-rm.14
-rw-r--r--doc/man/git-bug-label.14
-rw-r--r--doc/man/git-bug-select.19
-rw-r--r--doc/man/git-bug-title-edit.14
-rw-r--r--doc/man/git-bug-title.14
-rw-r--r--doc/man/git-bug-user-adopt.12
-rw-r--r--doc/man/git-bug-user.12
-rw-r--r--doc/md/git-bug.md6
-rw-r--r--doc/md/git-bug_comment.md6
-rw-r--r--doc/md/git-bug_comment_add.md6
-rw-r--r--doc/md/git-bug_label.md8
-rw-r--r--doc/md/git-bug_label_add.md6
-rw-r--r--doc/md/git-bug_label_rm.md6
-rw-r--r--doc/md/git-bug_select.md8
-rw-r--r--doc/md/git-bug_title.md6
-rw-r--r--doc/md/git-bug_title_edit.md6
-rw-r--r--doc/md/git-bug_user.md2
-rw-r--r--doc/md/git-bug_user_adopt.md2
21 files changed, 60 insertions, 43 deletions
diff --git a/doc/man/git-bug-comment-add.1 b/doc/man/git-bug-comment-add.1
index f68a8bf9..f2763120 100644
--- a/doc/man/git-bug-comment-add.1
+++ b/doc/man/git-bug-comment-add.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-comment\-add \- Add a new comment.
+git\-bug\-comment\-add \- Add a new comment to a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-comment\-add \- Add a new comment.
.SH DESCRIPTION
.PP
-Add a new comment.
+Add a new comment to a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-comment.1
index 234d7a01..f8d012ad 100644
--- a/doc/man/git-bug-comment.1
+++ b/doc/man/git-bug-comment.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-comment \- Display or add comments.
+git\-bug\-comment \- Display or add comments to a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-comment \- Display or add comments.
.SH DESCRIPTION
.PP
-Display or add comments.
+Display or add comments to a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-label-add.1 b/doc/man/git-bug-label-add.1
index a90e1d22..789bdd30 100644
--- a/doc/man/git-bug-label-add.1
+++ b/doc/man/git-bug-label-add.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-label\-add \- Add a label.
+git\-bug\-label\-add \- Add a label to a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-label\-add \- Add a label.
.SH DESCRIPTION
.PP
-Add a label.
+Add a label to a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-label-rm.1 b/doc/man/git-bug-label-rm.1
index 61b24a9a..07eacb38 100644
--- a/doc/man/git-bug-label-rm.1
+++ b/doc/man/git-bug-label-rm.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-label\-rm \- Remove a label.
+git\-bug\-label\-rm \- Remove a label from a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-label\-rm \- Remove a label.
.SH DESCRIPTION
.PP
-Remove a label.
+Remove a label from a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-label.1 b/doc/man/git-bug-label.1
index 2c005603..768787fa 100644
--- a/doc/man/git-bug-label.1
+++ b/doc/man/git-bug-label.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-label \- Display, add or remove labels.
+git\-bug\-label \- Display, add or remove labels to/from a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-label \- Display, add or remove labels.
.SH DESCRIPTION
.PP
-Display, add or remove labels.
+Display, add or remove labels to/from a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-select.1 b/doc/man/git-bug-select.1
index 677795c3..ab0bd421 100644
--- a/doc/man/git-bug-select.1
+++ b/doc/man/git-bug-select.1
@@ -17,6 +17,15 @@ git\-bug\-select \- Select a bug for implicit use in future commands.
.PP
Select a bug for implicit use in future commands.
+.PP
+This command allows you to omit any bug <id> argument, for example:
+ git bug show
+instead of
+ git bug show 2f153ca
+
+.PP
+The complementary command is "git bug deselect" performing the opposite operation.
+
.SH OPTIONS
.PP
diff --git a/doc/man/git-bug-title-edit.1 b/doc/man/git-bug-title-edit.1
index 642f7baa..0ba23307 100644
--- a/doc/man/git-bug-title-edit.1
+++ b/doc/man/git-bug-title-edit.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-title\-edit \- Edit a title.
+git\-bug\-title\-edit \- Edit a title of a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-title\-edit \- Edit a title.
.SH DESCRIPTION
.PP
-Edit a title.
+Edit a title of a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-title.1 b/doc/man/git-bug-title.1
index 9dd2c346..a46cf88a 100644
--- a/doc/man/git-bug-title.1
+++ b/doc/man/git-bug-title.1
@@ -5,7 +5,7 @@
.SH NAME
.PP
-git\-bug\-title \- Display or change a title.
+git\-bug\-title \- Display or change a title of a bug.
.SH SYNOPSIS
@@ -15,7 +15,7 @@ git\-bug\-title \- Display or change a title.
.SH DESCRIPTION
.PP
-Display or change a title.
+Display or change a title of a bug.
.SH OPTIONS
diff --git a/doc/man/git-bug-user-adopt.1 b/doc/man/git-bug-user-adopt.1
index 55e5f62f..83699060 100644
--- a/doc/man/git-bug-user-adopt.1
+++ b/doc/man/git-bug-user-adopt.1
@@ -10,7 +10,7 @@ git\-bug\-user\-adopt \- Adopt an existing identity as your own.
.SH SYNOPSIS
.PP
-\fBgit\-bug user adopt <id> [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 083db84c..279aa62d 100644
--- a/doc/man/git-bug-user.1
+++ b/doc/man/git-bug-user.1
@@ -10,7 +10,7 @@ git\-bug\-user \- Display or change the user identity.
.SH SYNOPSIS
.PP
-\fBgit\-bug user [<id>] [flags]\fP
+\fBgit\-bug user [<user-id>] [flags]\fP
.SH DESCRIPTION
diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md
index 1de9133b..b47bd5c2 100644
--- a/doc/md/git-bug.md
+++ b/doc/md/git-bug.md
@@ -27,9 +27,9 @@ git-bug [flags]
* [git-bug add](git-bug_add.md) - Create a new bug.
* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers.
* [git-bug commands](git-bug_commands.md) - Display available commands.
-* [git-bug comment](git-bug_comment.md) - Display or add comments.
+* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug.
* [git-bug deselect](git-bug_deselect.md) - Clear the implicitly selected bug.
-* [git-bug label](git-bug_label.md) - Display, add or remove labels.
+* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug.
* [git-bug ls](git-bug_ls.md) - List bugs.
* [git-bug ls-id](git-bug_ls-id.md) - List Bug Id
* [git-bug ls-label](git-bug_ls-label.md) - List valid labels.
@@ -39,7 +39,7 @@ git-bug [flags]
* [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.
* [git-bug termui](git-bug_termui.md) - Launch the terminal UI.
-* [git-bug title](git-bug_title.md) - Display or change a title.
+* [git-bug title](git-bug_title.md) - Display or change a title of a bug.
* [git-bug user](git-bug_user.md) - Display or change the user identity.
* [git-bug version](git-bug_version.md) - Show git-bug version information.
* [git-bug webui](git-bug_webui.md) - Launch the web UI.
diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md
index 31a80e51..5a79cf6f 100644
--- a/doc/md/git-bug_comment.md
+++ b/doc/md/git-bug_comment.md
@@ -1,10 +1,10 @@
## git-bug comment
-Display or add comments.
+Display or add comments to a bug.
### Synopsis
-Display or add comments.
+Display or add comments to a bug.
```
git-bug comment [<id>] [flags]
@@ -19,5 +19,5 @@ git-bug comment [<id>] [flags]
### SEE ALSO
* [git-bug](git-bug.md) - A bug tracker embedded in Git.
-* [git-bug comment add](git-bug_comment_add.md) - Add a new comment.
+* [git-bug comment add](git-bug_comment_add.md) - Add a new comment to a bug.
diff --git a/doc/md/git-bug_comment_add.md b/doc/md/git-bug_comment_add.md
index 5a1e429e..51114f7d 100644
--- a/doc/md/git-bug_comment_add.md
+++ b/doc/md/git-bug_comment_add.md
@@ -1,10 +1,10 @@
## git-bug comment add
-Add a new comment.
+Add a new comment to a bug.
### Synopsis
-Add a new comment.
+Add a new comment to a bug.
```
git-bug comment add [<id>] [flags]
@@ -20,5 +20,5 @@ git-bug comment add [<id>] [flags]
### SEE ALSO
-* [git-bug comment](git-bug_comment.md) - Display or add comments.
+* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug.
diff --git a/doc/md/git-bug_label.md b/doc/md/git-bug_label.md
index df2cae5a..5ac7c2e6 100644
--- a/doc/md/git-bug_label.md
+++ b/doc/md/git-bug_label.md
@@ -1,10 +1,10 @@
## git-bug label
-Display, add or remove labels.
+Display, add or remove labels to/from a bug.
### Synopsis
-Display, add or remove labels.
+Display, add or remove labels to/from a bug.
```
git-bug label [<id>] [flags]
@@ -19,6 +19,6 @@ git-bug label [<id>] [flags]
### SEE ALSO
* [git-bug](git-bug.md) - A bug tracker embedded in Git.
-* [git-bug label add](git-bug_label_add.md) - Add a label.
-* [git-bug label rm](git-bug_label_rm.md) - Remove a label.
+* [git-bug label add](git-bug_label_add.md) - Add a label to a bug.
+* [git-bug label rm](git-bug_label_rm.md) - Remove a label from a bug.
diff --git a/doc/md/git-bug_label_add.md b/doc/md/git-bug_label_add.md
index 9e642734..ee0a82ad 100644
--- a/doc/md/git-bug_label_add.md
+++ b/doc/md/git-bug_label_add.md
@@ -1,10 +1,10 @@
## git-bug label add
-Add a label.
+Add a label to a bug.
### Synopsis
-Add a label.
+Add a label to a bug.
```
git-bug label add [<id>] <label>[...] [flags]
@@ -18,5 +18,5 @@ git-bug label add [<id>] <label>[...] [flags]
### SEE ALSO
-* [git-bug label](git-bug_label.md) - Display, add or remove labels.
+* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug.
diff --git a/doc/md/git-bug_label_rm.md b/doc/md/git-bug_label_rm.md
index 850b4d58..b447f44d 100644
--- a/doc/md/git-bug_label_rm.md
+++ b/doc/md/git-bug_label_rm.md
@@ -1,10 +1,10 @@
## git-bug label rm
-Remove a label.
+Remove a label from a bug.
### Synopsis
-Remove a label.
+Remove a label from a bug.
```
git-bug label rm [<id>] <label>[...] [flags]
@@ -18,5 +18,5 @@ git-bug label rm [<id>] <label>[...] [flags]
### SEE ALSO
-* [git-bug label](git-bug_label.md) - Display, add or remove labels.
+* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug.
diff --git a/doc/md/git-bug_select.md b/doc/md/git-bug_select.md
index c8125380..6a851acb 100644
--- a/doc/md/git-bug_select.md
+++ b/doc/md/git-bug_select.md
@@ -6,6 +6,14 @@ 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:
+ git bug show
+instead of
+ git bug show 2f153ca
+
+The complementary command is "git bug deselect" performing the opposite operation.
+
+
```
git-bug select <id> [flags]
```
diff --git a/doc/md/git-bug_title.md b/doc/md/git-bug_title.md
index 2e51b06f..cb326071 100644
--- a/doc/md/git-bug_title.md
+++ b/doc/md/git-bug_title.md
@@ -1,10 +1,10 @@
## git-bug title
-Display or change a title.
+Display or change a title of a bug.
### Synopsis
-Display or change a title.
+Display or change a title of a bug.
```
git-bug title [<id>] [flags]
@@ -19,5 +19,5 @@ git-bug title [<id>] [flags]
### SEE ALSO
* [git-bug](git-bug.md) - A bug tracker embedded in Git.
-* [git-bug title edit](git-bug_title_edit.md) - Edit a title.
+* [git-bug title edit](git-bug_title_edit.md) - Edit a title of a bug.
diff --git a/doc/md/git-bug_title_edit.md b/doc/md/git-bug_title_edit.md
index 63c7168b..edf44a1a 100644
--- a/doc/md/git-bug_title_edit.md
+++ b/doc/md/git-bug_title_edit.md
@@ -1,10 +1,10 @@
## git-bug title edit
-Edit a title.
+Edit a title of a bug.
### Synopsis
-Edit a title.
+Edit a title of a bug.
```
git-bug title edit [<id>] [flags]
@@ -19,5 +19,5 @@ git-bug title edit [<id>] [flags]
### SEE ALSO
-* [git-bug title](git-bug_title.md) - Display or change a title.
+* [git-bug title](git-bug_title.md) - Display or change a title of a bug.
diff --git a/doc/md/git-bug_user.md b/doc/md/git-bug_user.md
index 8121b750..fe81a2c0 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 [<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 f89cdf68..7bedace5 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 <id> [flags]
+git-bug user adopt <user-id> [flags]
```
### Options
generated by cgit (git 2.34.1) at 2024-11-06 05:47:49 +0000