From d064a7127ec612a804e08143c7098bbc60332e83 Mon Sep 17 00:00:00 2001 From: Amine Hilaly Date: Wed, 29 May 2019 20:50:30 +0200 Subject: Update man pages and bash_completion --- doc/man/git-bug-bridge-configure.1 | 87 +++++++++++++++++++++++++++++++++++++- doc/man/git-bug-bridge-rm.1 | 2 +- 2 files changed, 87 insertions(+), 2 deletions(-) (limited to 'doc/man') diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-configure.1 index 27dfeac0..21ea7df1 100644 --- a/doc/man/git-bug-bridge-configure.1 +++ b/doc/man/git-bug-bridge-configure.1 @@ -15,15 +15,100 @@ git\-bug\-bridge\-configure \- Configure a new bridge. .SH DESCRIPTION .PP -Configure a new bridge. +.RS + +.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 .SH OPTIONS +.PP +\fB\-n\fP, \fB\-\-name\fP="" + A distinctive name to identify the bridge + +.PP +\fB\-t\fP, \fB\-\-target\fP="" + The target of the bridge. Valid values are [github,launchpad\-preview] + +.PP +\fB\-u\fP, \fB\-\-url\fP="" + The URL of the target repository + +.PP +\fB\-o\fP, \fB\-\-owner\fP="" + The owner of the target repository + +.PP +\fB\-T\fP, \fB\-\-token\fP="" + The authentication token for the API + +.PP +\fB\-p\fP, \fB\-\-project\fP="" + The name of the target repository + .PP \fB\-h\fP, \fB\-\-help\fP[=false] help for configure +.SH EXAMPLE +.PP +.RS + +.nf +# Interactive example +[1]: github +[2]: launchpad\-preview +target: 1 +name [default]: default + +Detected projects: +[1]: github.com/a\-hilaly/git\-bug +[2]: github.com/MichaelMure/git\-bug + +[0]: Another project + +Select option: 1 + +[0]: user provided token +[1]: interactive token creation +Select option: 0 + +You can generate a new token by visiting https://github.com/settings/tokens. +Choose 'Generate new token' and set the necessary access scope for your repository. + +The access scope depend on the type of repository. +Public: + \- 'public\_repo': to be able to read public repositories +Private: + \- 'repo' : to be able to read private repositories + +Enter token: +Successfully configured bridge: default + +# For Github +git bug bridge configure \\ + \-\-name=default \\ + \-\-target=github \\ + \-\-owner=$(OWNER) \\ + \-\-project=$(PROJECT) \\ + \-\-token=$(TOKEN) + +# For Launchpad +git bug bridge configure \\ + \-\-name=default \\ + \-\-target=launchpad\-preview \\ + \-\-url=https://bugs.launchpad.net/ubuntu/ + +.fi +.RE + + .SH SEE ALSO .PP \fBgit\-bug\-bridge(1)\fP diff --git a/doc/man/git-bug-bridge-rm.1 b/doc/man/git-bug-bridge-rm.1 index 630eba93..324d4237 100644 --- a/doc/man/git-bug-bridge-rm.1 +++ b/doc/man/git-bug-bridge-rm.1 @@ -10,7 +10,7 @@ git\-bug\-bridge\-rm \- Delete a configured bridge. .SH SYNOPSIS .PP -\fBgit\-bug bridge rm name [flags]\fP +\fBgit\-bug bridge rm [flags]\fP .SH DESCRIPTION -- cgit From 8d6bdb65074f9e75c014b86dd744b7bba72b349b Mon Sep 17 00:00:00 2001 From: Amine Hilaly Date: Fri, 7 Jun 2019 01:28:52 +0200 Subject: rename GITHUB_TOKEN to GITHUB_PRIVATE_TOKEN --- doc/man/git-bug-bridge-configure.1 | 8 ++++---- doc/man/git-bug-bridge-rm.1 | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/man') diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-configure.1 index 21ea7df1..fa6feed5 100644 --- a/doc/man/git-bug-bridge-configure.1 +++ b/doc/man/git-bug-bridge-configure.1 @@ -75,9 +75,9 @@ Detected projects: Select option: 1 -[0]: user provided token -[1]: interactive token creation -Select option: 0 +[1]: user provided token +[2]: interactive token creation +Select option: 1 You can generate a new token by visiting https://github.com/settings/tokens. Choose 'Generate new token' and set the necessary access scope for your repository. @@ -88,7 +88,7 @@ Public: Private: \- 'repo' : to be able to read private repositories -Enter token: +Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 Successfully configured bridge: default # For Github diff --git a/doc/man/git-bug-bridge-rm.1 b/doc/man/git-bug-bridge-rm.1 index 324d4237..630eba93 100644 --- a/doc/man/git-bug-bridge-rm.1 +++ b/doc/man/git-bug-bridge-rm.1 @@ -10,7 +10,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 -- cgit