chore: regenerate command completion and documentation (#1253)

sudoforge created 1 year ago

Closes: #1209
Change-Id: Id19d5013b04ef5c99a99d367bbf3d618b8be068b

Change summary

doc/man/git-bug-bridge-new.1       | 24 +++++++++---------------
doc/man/git-bug-bug-deselect.1     |  9 ++-------
doc/man/git-bug-bug-select.1       |  9 ++-------
doc/man/git-bug-bug.1              |  9 ++-------
doc/md/git-bug_bridge_new.md       | 13 ++++++-------
misc/completion/bash/git-bug       |  2 +-
misc/completion/fish/git-bug       |  2 +-
misc/completion/powershell/git-bug |  6 +++---
8 files changed, 26 insertions(+), 48 deletions(-)

Detailed changes

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

@@ -67,10 +67,7 @@ Configure a new bridge by passing flags or/and using interactive terminal prompt
 
 
 .SH EXAMPLE
-.PP
-.RS
-
-.nf
+.EX
 # Interactive example
 [1]: github
 [2]: gitlab
@@ -81,8 +78,7 @@ target: 1
 name [default]: default
 
 Detected projects:
-[1]: github.com/a-hilaly/git-bug
-[2]: github.com/git-bug/git-bug
+[1]: github.com/git-bug/git-bug
 
 [0]: Another project
 
@@ -108,9 +104,9 @@ Successfully configured bridge: default
 git bug bridge new \\
     --name=default \\
     --target=github \\
-    --owner=$(OWNER) \\
-    --project=$(PROJECT) \\
-    --token=$(TOKEN)
+    --owner=example-owner
+    --project=example-repo \\
+    --token=$TOKEN
 
 # For Launchpad
 git bug bridge new \\
@@ -121,12 +117,10 @@ git bug bridge new \\
 # For Gitlab
 git bug bridge new \\
     --name=default \\
-    --target=github \\
-    --url=https://gitlab.com/git-bug/git-bug \\
-    --token=$(TOKEN)
-
-.fi
-.RE
+    --target=gitlab \\
+    --url=https://github.com/example-org/example-repo \\
+    --token=$TOKEN
+.EE
 
 
 .SH SEE ALSO

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

@@ -23,18 +23,13 @@ Clear the implicitly selected bug
 
 
 .SH EXAMPLE
-.PP
-.RS
-
-.nf
+.EX
 git bug select 2f15
 git bug comment
 git bug status
 git bug deselect
 
-
-.fi
-.RE
+.EE
 
 
 .SH SEE ALSO

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

@@ -32,17 +32,12 @@ The complementary command is "git bug deselect" performing the opposite operatio
 
 
 .SH EXAMPLE
-.PP
-.RS
-
-.nf
+.EX
 git bug select 2f15
 git bug comment
 git bug status
 
-
-.fi
-.RE
+.EE
 
 
 .SH SEE ALSO

doc/man/git-bug-bug.1

@@ -70,10 +70,7 @@ You can pass an additional query to filter and order the list. This query can be
 
 
 .SH EXAMPLE
-.PP
-.RS
-
-.nf
+.EX
 List open bugs sorted by last edition with a query:
 git bug status:open sort:edit-desc
 
@@ -86,9 +83,7 @@ git bug "foo bar" baz
 Use queries, flags, and full text search:
 git bug status:open --by creation "foo bar" baz
 
-
-.fi
-.RE
+.EE
 
 
 .SH SEE ALSO

doc/md/git-bug_bridge_new.md

@@ -23,8 +23,7 @@ target: 1
 name [default]: default
 
 Detected projects:
-[1]: github.com/a-hilaly/git-bug
-[2]: github.com/git-bug/git-bug
+[1]: github.com/git-bug/git-bug
 
 [0]: Another project
 
@@ -50,9 +49,9 @@ Successfully configured bridge: default
 git bug bridge new \
     --name=default \
     --target=github \
-    --owner=$(OWNER) \
-    --project=$(PROJECT) \
-    --token=$(TOKEN)
+    --owner=example-owner
+    --project=example-repo \
+    --token=$TOKEN
 
 # For Launchpad
 git bug bridge new \
@@ -64,8 +63,8 @@ git bug bridge new \
 git bug bridge new \
     --name=default \
     --target=gitlab \
-    --url=https://gitlab.com/git-bug/git-bug \
-    --token=$(TOKEN)
+    --url=https://github.com/example-org/example-repo \
+    --token=$TOKEN
 ```
 
 ### Options

misc/completion/bash/git-bug

@@ -21,7 +21,7 @@ __git-bug_get_completion_results() {
     local requestComp lastParam lastChar args
 
     # Prepare the command to request completions for the program.
-    # Calling ${words[0]} instead of directly git-bug allows to handle aliases
+    # Calling ${words[0]} instead of directly git-bug allows handling aliases
     args=("${words[@]:1}")
     requestComp="${words[0]} __complete ${args[*]}"
 

misc/completion/fish/git-bug

@@ -79,7 +79,7 @@ function __git_bug_clear_perform_completion_once_result
     __git_bug_debug ""
     __git_bug_debug "========= clearing previously set __git_bug_perform_completion_once_result variable =========="
     set --erase __git_bug_perform_completion_once_result
-    __git_bug_debug "Succesfully erased the variable __git_bug_perform_completion_once_result"
+    __git_bug_debug "Successfully erased the variable __git_bug_perform_completion_once_result"
 end
 
 function __git_bug_requires_order_preservation

misc/completion/powershell/git-bug

@@ -10,7 +10,7 @@ filter __git-bug_escapeStringWithSpecialChars {
     $_ -replace '\s|#|@|\$|;|,|''|\{|\}|\(|\)|"|`|\||<|>|&','`$&'
 }
 
-[scriptblock]$__git_bugCompleterBlock = {
+[scriptblock]${__git_bugCompleterBlock} = {
     param(
             $WordToComplete,
             $CommandAst,
@@ -85,7 +85,7 @@ filter __git-bug_escapeStringWithSpecialChars {
 
     __git-bug_debug "Calling $RequestComp"
     # First disable ActiveHelp which is not supported for Powershell
-    $env:GIT_BUG_ACTIVE_HELP=0
+    ${env:GIT_BUG_ACTIVE_HELP}=0
 
     #call the command store the output in $out and redirect stderr and stdout to null
     # $Out is an array contains each line per element
@@ -242,4 +242,4 @@ filter __git-bug_escapeStringWithSpecialChars {
     }
 }
 
-Register-ArgumentCompleter -CommandName 'git-bug' -ScriptBlock $__git_bugCompleterBlock
+Register-ArgumentCompleter -CommandName 'git-bug' -ScriptBlock ${__git_bugCompleterBlock}