Skip to content

Commit c3ff05f

Browse files
authored
chore: regenerate command completion and documentation (git-bug#1253)
Closes: git-bug#1209 Change-Id: Id19d5013b04ef5c99a99d367bbf3d618b8be068b
1 parent 2004fa7 commit c3ff05f

File tree

8 files changed

+26
-48
lines changed

8 files changed

+26
-48
lines changed

doc/man/git-bug-bridge-new.1

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,7 @@ Configure a new bridge by passing flags or/and using interactive terminal prompt
6767

6868

6969
.SH EXAMPLE
70-
.PP
71-
.RS
72-
73-
.nf
70+
.EX
7471
# Interactive example
7572
[1]: github
7673
[2]: gitlab
@@ -81,8 +78,7 @@ target: 1
8178
name [default]: default
8279
8380
Detected projects:
84-
[1]: github.com/a-hilaly/git-bug
85-
[2]: github.com/git-bug/git-bug
81+
[1]: github.com/git-bug/git-bug
8682
8783
[0]: Another project
8884
@@ -108,9 +104,9 @@ Successfully configured bridge: default
108104
git bug bridge new \\
109105
--name=default \\
110106
--target=github \\
111-
--owner=$(OWNER) \\
112-
--project=$(PROJECT) \\
113-
--token=$(TOKEN)
107+
--owner=example-owner
108+
--project=example-repo \\
109+
--token=$TOKEN
114110
115111
# For Launchpad
116112
git bug bridge new \\
@@ -121,12 +117,10 @@ git bug bridge new \\
121117
# For Gitlab
122118
git bug bridge new \\
123119
--name=default \\
124-
--target=github \\
125-
--url=https://gitlab.com/git-bug/git-bug \\
126-
--token=$(TOKEN)
127-
128-
.fi
129-
.RE
120+
--target=gitlab \\
121+
--url=https://github.com/example-org/example-repo \\
122+
--token=$TOKEN
123+
.EE
130124

131125

132126
.SH SEE ALSO

doc/man/git-bug-bug-deselect.1

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,13 @@ Clear the implicitly selected bug
2323

2424

2525
.SH EXAMPLE
26-
.PP
27-
.RS
28-
29-
.nf
26+
.EX
3027
git bug select 2f15
3128
git bug comment
3229
git bug status
3330
git bug deselect
3431
35-
36-
.fi
37-
.RE
32+
.EE
3833

3934

4035
.SH SEE ALSO

doc/man/git-bug-bug-select.1

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,12 @@ The complementary command is "git bug deselect" performing the opposite operatio
3232

3333

3434
.SH EXAMPLE
35-
.PP
36-
.RS
37-
38-
.nf
35+
.EX
3936
git bug select 2f15
4037
git bug comment
4138
git bug status
4239
43-
44-
.fi
45-
.RE
40+
.EE
4641

4742

4843
.SH SEE ALSO

doc/man/git-bug-bug.1

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,7 @@ You can pass an additional query to filter and order the list. This query can be
7070

7171

7272
.SH EXAMPLE
73-
.PP
74-
.RS
75-
76-
.nf
73+
.EX
7774
List open bugs sorted by last edition with a query:
7875
git bug status:open sort:edit-desc
7976
@@ -86,9 +83,7 @@ git bug "foo bar" baz
8683
Use queries, flags, and full text search:
8784
git bug status:open --by creation "foo bar" baz
8885
89-
90-
.fi
91-
.RE
86+
.EE
9287

9388

9489
.SH SEE ALSO

doc/md/git-bug_bridge_new.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ target: 1
2323
name [default]: default
2424
2525
Detected projects:
26-
[1]: github.com/a-hilaly/git-bug
27-
[2]: github.com/git-bug/git-bug
26+
[1]: github.com/git-bug/git-bug
2827
2928
[0]: Another project
3029
@@ -50,9 +49,9 @@ Successfully configured bridge: default
5049
git bug bridge new \
5150
--name=default \
5251
--target=github \
53-
--owner=$(OWNER) \
54-
--project=$(PROJECT) \
55-
--token=$(TOKEN)
52+
--owner=example-owner
53+
--project=example-repo \
54+
--token=$TOKEN
5655
5756
# For Launchpad
5857
git bug bridge new \
@@ -64,8 +63,8 @@ git bug bridge new \
6463
git bug bridge new \
6564
--name=default \
6665
--target=gitlab \
67-
--url=https://gitlab.com/git-bug/git-bug \
68-
--token=$(TOKEN)
66+
--url=https://github.com/example-org/example-repo \
67+
--token=$TOKEN
6968
```
7069

7170
### Options

misc/completion/bash/git-bug

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ __git-bug_get_completion_results() {
2121
local requestComp lastParam lastChar args
2222

2323
# Prepare the command to request completions for the program.
24-
# Calling ${words[0]} instead of directly git-bug allows to handle aliases
24+
# Calling ${words[0]} instead of directly git-bug allows handling aliases
2525
args=("${words[@]:1}")
2626
requestComp="${words[0]} __complete ${args[*]}"
2727

misc/completion/fish/git-bug

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ function __git_bug_clear_perform_completion_once_result
7979
__git_bug_debug ""
8080
__git_bug_debug "========= clearing previously set __git_bug_perform_completion_once_result variable =========="
8181
set --erase __git_bug_perform_completion_once_result
82-
__git_bug_debug "Succesfully erased the variable __git_bug_perform_completion_once_result"
82+
__git_bug_debug "Successfully erased the variable __git_bug_perform_completion_once_result"
8383
end
8484

8585
function __git_bug_requires_order_preservation

misc/completion/powershell/git-bug

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ filter __git-bug_escapeStringWithSpecialChars {
1010
$_ -replace '\s|#|@|\$|;|,|''|\{|\}|\(|\)|"|`|\||<|>|&','`$&'
1111
}
1212

13-
[scriptblock]$__git_bugCompleterBlock = {
13+
[scriptblock]${__git_bugCompleterBlock} = {
1414
param(
1515
$WordToComplete,
1616
$CommandAst,
@@ -85,7 +85,7 @@ filter __git-bug_escapeStringWithSpecialChars {
8585

8686
__git-bug_debug "Calling $RequestComp"
8787
# First disable ActiveHelp which is not supported for Powershell
88-
$env:GIT_BUG_ACTIVE_HELP=0
88+
${env:GIT_BUG_ACTIVE_HELP}=0
8989

9090
#call the command store the output in $out and redirect stderr and stdout to null
9191
# $Out is an array contains each line per element
@@ -242,4 +242,4 @@ filter __git-bug_escapeStringWithSpecialChars {
242242
}
243243
}
244244
245-
Register-ArgumentCompleter -CommandName 'git-bug' -ScriptBlock $__git_bugCompleterBlock
245+
Register-ArgumentCompleter -CommandName 'git-bug' -ScriptBlock ${__git_bugCompleterBlock}

0 commit comments

Comments
 (0)