diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/git-bug-bridge-auth-add-token.1 | 2 | ||||
| -rw-r--r-- | doc/man/git-bug-bridge-configure.1 | 27 | ||||
| -rw-r--r-- | doc/md/git-bug_bridge_auth_add-token.md | 2 | ||||
| -rw-r--r-- | doc/md/git-bug_bridge_configure.md | 22 |
4 files changed, 30 insertions, 23 deletions
diff --git a/doc/man/git-bug-bridge-auth-add-token.1 b/doc/man/git-bug-bridge-auth-add-token.1 index 717610e1..c9ca55d6 100644 --- a/doc/man/git-bug-bridge-auth-add-token.1 +++ b/doc/man/git-bug-bridge-auth-add-token.1 @@ -21,7 +21,7 @@ Store a new token .SH OPTIONS .PP \fB\-t\fP, \fB\-\-target\fP="" - The target of the bridge. Valid values are [github,gitlab,jira,launchpad\-preview] + The target of the bridge. Valid values are [github,gitlab,launchpad\-preview] .PP \fB\-l\fP, \fB\-\-login\fP="" diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-configure.1 index 6df61e19..385d0949 100644 --- a/doc/man/git-bug-bridge-configure.1 +++ b/doc/man/git-bug-bridge-configure.1 @@ -19,8 +19,6 @@ git\-bug\-bridge\-configure \- Configure a new bridge. .nf Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge. -Repository configuration can be made by passing either the \-\-url flag or the \-\-project and \-\-owner flags. If the three flags are provided git\-bug will use \-\-project and \-\-owner flags. -Token configuration can be directly passed with the \-\-token flag or in the terminal prompt. If you don't already have one you can use the interactive procedure to generate one. .fi .RE @@ -33,35 +31,39 @@ Token configuration can be directly passed with the \-\-token flag or in the ter .PP \fB\-t\fP, \fB\-\-target\fP="" - The target of the bridge. Valid values are [github,gitlab,jira,launchpad\-preview] + The target of the bridge. Valid values are [github,gitlab,launchpad\-preview] .PP \fB\-u\fP, \fB\-\-url\fP="" - The URL of the target repository + The URL of the remote repository .PP \fB\-b\fP, \fB\-\-base\-url\fP="" - The base URL of your issue tracker service + The base URL of your remote issue tracker .PP -\fB\-o\fP, \fB\-\-owner\fP="" - The owner of the target repository +\fB\-l\fP, \fB\-\-login\fP="" + The login on your remote issue tracker .PP \fB\-c\fP, \fB\-\-credential\fP="" - The identifier or prefix of an already known credential for the API (see "git\-bug bridge auth") + The identifier or prefix of an already known credential for your remote issue tracker (see "git\-bug bridge auth") .PP \fB\-\-token\fP="" - A raw authentication token for the API + A raw authentication token for the remote issue tracker .PP \fB\-\-token\-stdin\fP[=false] Will read the token from stdin and ignore \-\-token .PP +\fB\-o\fP, \fB\-\-owner\fP="" + The owner of the remote repository + +.PP \fB\-p\fP, \fB\-\-project\fP="" - The name of the target repository + The name of the remote repository .PP \fB\-h\fP, \fB\-\-help\fP[=false] @@ -75,7 +77,10 @@ Token configuration can be directly passed with the \-\-token flag or in the ter .nf # Interactive example [1]: github -[2]: launchpad\-preview +[2]: gitlab +[3]: jira +[4]: launchpad\-preview + target: 1 name [default]: default diff --git a/doc/md/git-bug_bridge_auth_add-token.md b/doc/md/git-bug_bridge_auth_add-token.md index f0f8ac72..496455a0 100644 --- a/doc/md/git-bug_bridge_auth_add-token.md +++ b/doc/md/git-bug_bridge_auth_add-token.md @@ -13,7 +13,7 @@ git-bug bridge auth add-token [<token>] [flags] ### Options ``` - -t, --target string The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview] + -t, --target string The target of the bridge. Valid values are [github,gitlab,launchpad-preview] -l, --login string The login in the remote bug-tracker -u, --user string The user to add the token to. Default is the current user -h, --help help for add-token diff --git a/doc/md/git-bug_bridge_configure.md b/doc/md/git-bug_bridge_configure.md index e073837d..9695684b 100644 --- a/doc/md/git-bug_bridge_configure.md +++ b/doc/md/git-bug_bridge_configure.md @@ -5,8 +5,6 @@ Configure a new bridge. ### Synopsis Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge. - Repository configuration can be made by passing either the --url flag or the --project and --owner flags. If the three flags are provided git-bug will use --project and --owner flags. - Token configuration can be directly passed with the --token flag or in the terminal prompt. If you don't already have one you can use the interactive procedure to generate one. ``` git-bug bridge configure [flags] @@ -17,7 +15,10 @@ git-bug bridge configure [flags] ``` # Interactive example [1]: github -[2]: launchpad-preview +[2]: gitlab +[3]: jira +[4]: launchpad-preview + target: 1 name [default]: default @@ -71,14 +72,15 @@ git bug bridge configure \ ``` -n, --name string A distinctive name to identify the bridge - -t, --target string The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview] - -u, --url string The URL of the target repository - -b, --base-url string The base URL of your issue tracker service - -o, --owner string The owner of the target repository - -c, --credential string The identifier or prefix of an already known credential for the API (see "git-bug bridge auth") - --token string A raw authentication token for the API + -t, --target string The target of the bridge. Valid values are [github,gitlab,launchpad-preview] + -u, --url string The URL of the remote repository + -b, --base-url string The base URL of your remote issue tracker + -l, --login string The login on your remote issue tracker + -c, --credential string The identifier or prefix of an already known credential for your remote issue tracker (see "git-bug bridge auth") + --token string A raw authentication token for the remote issue tracker --token-stdin Will read the token from stdin and ignore --token - -p, --project string The name of the target repository + -o, --owner string The owner of the remote repository + -p, --project string The name of the remote repository -h, --help help for configure ``` |