diff options
Diffstat (limited to 'doc')
40 files changed, 573 insertions, 226 deletions
diff --git a/doc/jira_bridge.md b/doc/jira_bridge.md new file mode 100644 index 00000000..df56bb2d --- /dev/null +++ b/doc/jira_bridge.md @@ -0,0 +1,377 @@ +# JIRA Bridge + +## Design Notes + +### One bridge = one project + +There aren't any huge technical barriers requiring this, but since git-bug lacks +a notion of "project" there is no way to know which project to export new bugs +to as issues. Also, JIRA projects are first-class immutable metadata and so we +*must* get it right on export. Therefore the bridge is configured with the `Key` +for the project it is assigned to. It will only import bugs from that project. + +### JIRA fields + +The bridge currently does nothing to import any of the JIRA fields that don't +have `git-bug` equivalents ("Assignee", "sprint", "story points", etc). +Hopefully the bridge will be able to enable synchronization of these soon. + +### Credentials + +JIRA does not support user/personal access tokens. They have experimental +3-legged oauth support but that requires an API token for the app configured +by the server administrator. The only reliable authentication mechanism then is +the username/password and session-token mechanims. We can aquire a session +token programatically from the username/password but these are very short lived +(i.e. hours or less). As such the bridge currently requires an actual username +and password as user credentials. It supports three options: + +1. Storing both username and password in a separate file referred to by + the `git-config` (I like to use `.git/jira-credentials.json`) +2. Storing the username and password in clear-text in the git config +3. Storing the username only in the git config and asking for the password + on each `push` or `pull`. + +### Issue Creation Defaults + +When a new issues is created in JIRA there are often certain mandatory fields +that require a value or the creation is rejected. In the issue create form on +the JIRA web interface, these are annotated as "required". The `issuetype` is +always required (e.g. "bug", "story", "task", etc). The set of required metadata +is configurable (in JIRA) per `issuetype` so the set might be different between +"bug" and "story", for example. + +For now, the bridge only supports exporting issues as a single `issuetype`. If +no configuration is provied, then the default is `"id": "10001"` which is +`"story"` in the default set of issue types. + +In addition to specifying the `issuetype` of issues created on export, the +bridge will also allow you to specify a constant global set of default values +for any additional required fields. See the configuration section below for the +syntax. + +For longer term goals, see the section below on workflow validation + +### Assign git-bug id to field during issue creation + +JIRA allows for the inclusion of custom "fields" in all of their issues. The +JIRA bridge will store the JIRA issue "id" for any bugs which are synchronized +to JIRA, but it can also assign to a custom JIRA `field` the `git-bug` id. This +way the `git-bug` id can be displayed in the JIRA web interface and certain +integration activities become easier. + +See the configuration section below on how to specify the custom field where the +JIRA bridge should write this information. + + +### Workflows and Transitions + +JIRA issue states are subject to customizable "workflows" (project managers +apparently validate themselves by introducing developer friction). In general, +issues can only transition from one state to another if there is an edge between +them in the state graph (a.k.a. "workflow"). JIRA calls these edges +"transitions". Furthermore, each transition may include a set of mandatory +fields which must be set in order for the transition to succeed. For example the +transition of `"status"` from `"In Progress"` to `"Closed"` might required a +`"resolution"` (i.e. `"Fixed"` or `"Working as intended"`). + +Dealing with complex workflows is going to be challenging. Some long-term +aspirations are described in the section below on "Workflow Validation". +Currently the JIRA bridge isn't very smart about transitions though, so you'll +need to tell it what you want it to do when importing and exporting a state +change (i.e. to "close" or "open" a bug). Currently the bridge accepts +configuration options which map the two `git-bug` statuses ("open", "closed") to +two JIRA statuses. On import, the JIRA status is mapped to a `git-bug` status +(if a mapping exists) and the `git-bug` status is assigned. On export, the +`git-bug` status is mapped to a JIRA status and if a mapping exists the bridge +will query the list of available transitions for the issue. If a transition +exists to the desired state the bridge will attempt to execute the transition. +It does not currently support assigning any fields during the transition so if +any fields are required the transition will fail during export and the status +will be out of sync. + +### JIRA Changelog + +Some operations on JIRA issues are visible in a timeline view known as the +`changelog`. The JIRA cloud product provides an +`/issue/{issueIdOrKey}/changelog` endpoint which provides a paginated view but +the JIRA server product does not. The changelog is visible by querying the issue +with the `expand=changelog` query parameter. Unfortunately in this case the +entire changelog is provided without paging. + +Each changelog entry is identified with a unique string `id`, but within a +single changelog entry is a list of multilple fields that are modified. In other +words a single "event" might atomically change multiple fields. As an example, +when an issue is closed the `"status"` might change to `"closed"` and the +`"resolution"` might change to `"fixed'`. + +When a changelog entry is imported by the JIRA bridge, each individual field +that was changed is treated as a separate `git-bug` operation. In other words a +single JIRA change event might create more than one `git-bug` operation. + +However, when a `git-bug` operation is exported to JIRA it will only create a +single changelog entry. Furthermore, when we modify JIRA issues over the REST +API JIRA does not provide any information to associate that modification event +with the changelog. We must, therefore, herustically match changelog entries +against operations that we performed in order to not import them as duplicate +events. In order to assist in this matching proceess, the bridge will record the +JIRA server time of the response to the `POST` (as reported by the `"Date"` +response header). During import, we keep an iterator to the list of `git-bug` +operations for the bug mapped to the Jira issue. As we walk the JIRA changelog, +we keep the iterator pointing to the first operation with an annotation which is +*not before* that changelog entry. If the changelog entry is the result of an +exported `git-bug` operation, then this must be that operation. We then scan +through the list of changeitems (changed fields) in the changelog entry, and if +we can match a changed field to the candidate `git-bug` operation then we have +identified the match. + +### Unlogged Changes + +Comments (creation and edition) do not show up in the JIRA changelog. However +JIRA reports both a `created` and `updated` date for each comment. If we +import a comment which has an `updated` and `created` field which do not match, +then we treat that as a new comment edition. If we do not already have the +comment imported, then we import an empty comment followed by a comment edition. + +Because comment editions are not uniquely identified in JIRA we identify them +in `git-bug` by concatinating the JIRA issue `id` with the `updated` time of +the edition. + +### Workflow Validation (future) + +The long-term plan for the JIRA bridge is to download and store the workflow +specifiations from the JIRA server. This includes the required metadata for +issue creation, and the status state graph, and the set of required metadata for +status transition. + +When an existing `git-bug` is initially marked for export, the bridge will hook +in and validate the bug state against the required metadata. Then it will prompt +for any missing metadata using a set of UI components appropriate for the field +schema as reported by JIRA. If the user cancels then the bug will not be marked +for export. + +When a bug already marked for JIRA export (including those that were imported) +is modified, the bridge will hook in and validate the modification against the +workflow specifications. It will prompt for any missing metadata as in the +creation process. + +During export, the bridge will validate any export operations and skip them if +we know they will fail due to violation of the cached workflow specification +(i.e. missing required fields for a transition). A list of bugs "blocked for +export" will be available to query. A UI command will allow the user to inspect +and resolve any bugs that are "blocked for export". + +## Configuration + +As mentioned in the notes above, there are a few optional configuration fields +that can be set beyond those that are prompted for during the initial bridge +configuration. You can set these options in your `.git/config` file: + +### Issue Creation Defaults + +The format for this config entry is a JSON object containing fields you wish to +set during issue creation when exproting bugs. If you provide a value for this +configuration option, it must include at least the `"issuetype"` field, or +the bridge will not be able to export any new issues. + +Let's say that we want bugs exported to JIRA to have a default issue type of +"Story" which is `issuetype` with id `10001`. Then we will add the following +entry to our git-config: + +``` +create-issue-defaults = {"issuetype":"10001"} +``` + +If you needed an additional required field `customfield_1234` and you wanted to +provide a default value of `"default"` then you would add the following to your +config: + +``` +create-issue-defaults = {"issuetype":"10001","customfield_1234":"default"} +``` + +Note that the content of this value is merged verbatim to the JSON object that +is `POST`ed to the JIRA rest API, so you can use arbitrary valid JSON. + + +### Assign git-bug id to field + +If you want the bridge to fill a JIRA field with the `git-bug` id when exporting +issues, then provide the name of the field: + +``` +create-issue-gitbug-id = "customfield_5678" +``` + +### Status Map + +You can specify the mapping between `git-bug` status and JIRA status id's using +the following: +``` +bug-id-map = {\"open\": \"1\", \"closed\": \"6\"} +``` + +The format of the map is `<git-bug-status-name>: <jira-status-id>`. In general +your jira instance will have more statuses than `git-bug` will and you may map +more than one jira-status to a git-bug status. You can do this with +`bug-id-revmap`: +``` +bug-id-revmap = {\"10109\": \"open\", \"10006\": \"open\", \"10814\": \"open\"} +``` + +The reverse map `bug-id-revmap` will automatically include the inverse of the +forward map `bug-id-map`. + +Note that in JIRA each different `issuetype` can have a different set of +statuses. The bridge doesn't currently support more than one mapping, however. +Also, note that the format of the map is JSON and the git config file syntax +requires doublequotes to be escaped (as in the examples above). + +### Full example + +Here is an example configuration with all optional fields set +``` +[git-bug "bridge.default"] + project = PROJ + credentials-file = .git/jira-credentials.json + target = jira + server = https://jira.example.com + create-issue-defaults = {"issuetype":"10001","customfield_1234":"default"} + create-issue-gitbug-id = "customfield_5678" + bug-open-id = 1 + bug-closed-id = 6 +``` + +## To-Do list + +* [0cf5c71] Assign git-bug to jira field on import +* [8acce9c] Download and cache workflow representation +* [95e3d45] Implement workflow gui +* [c70e22a] Implement additional query filters for import +* [9ecefaa] Create JIRA mock and add REST unit tests +* [67bf520] Create import/export integration tests +* [1121826] Add unit tests for utilites +* [0597088] Use OS keyring for credentials +* [d3e8f79] Don't count on the `Total` value in paginations + + +## Using CURL to poke at your JIRA's REST API + +If you need to lookup the `id` for any `status`es or the `schema` for any +creation metadata, you can use CURL to query the API from the command line. +Here are a couple of examples to get you started. + +### Getting a session token + +``` +curl \ + --data '{"username":"<username>", "password":"<password>"}' \ + --header "Content-Type: application/json" \ + --request POST \ + <serverUrl>/rest/auth/1/session +``` + +**Note**: If you have a json pretty printer installed (`sudo apt install jq`), +pipe the output through through that to make things more readable: + +``` +curl --silent \ + --data '{"username":"<username>", "password":"<password>"}' \ + --header "Content-Type: application/json" \ + --request POST + <serverUrl>/rest/auth/1/session | jq . +``` + +example output: +``` +{ + "session": { + "name": "JSESSIONID", + "value": "{sessionToken}" + }, + "loginInfo": { + "loginCount": 268, + "previousLoginTime": "2019-11-12T08:03:35.300-0800" + } +} +``` + +Make note of the output value. On subsequent invocations of `curl`, append the +following command-line option: + +``` +--cookie "JSESSIONID={sessionToken}" +``` + +Where `{sessionToken}` is the output from the `POST` above. + +### Get a list of issuetype ids + +``` +curl --silent \ + --cookie "JSESSIONID={sessionToken}" \ + --header "Content-Type: application/json" \ + --request GET https://jira.example.com/rest/api/2/issuetype \ + | jq . +``` + +**example output**: +``` + { + "self": "https://jira.example.com/rest/api/2/issuetype/13105", + "id": "13105", + "description": "", + "iconUrl": "https://jira.example.com/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype", + "name": "Test Plan Links", + "subtask": true, + "avatarId": 10316 + }, + { + "self": "https://jira.example.com/rest/api/2/issuetype/13106", + "id": "13106", + "description": "", + "iconUrl": "https://jira.example.com/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype", + "name": "Enable Initiatives on the project", + "subtask": true, + "avatarId": 10316 + }, + ... +``` + + +### Get a list of statuses + + +``` +curl --silent \ + --cookie "JSESSIONID={sessionToken}" \ + --header "Content-Type: application/json" \ + --request GET https://jira.example.com/rest/api/2/project/{projectIdOrKey}/statuses \ + | jq . +``` + +**example output:** +``` +[ + { + "self": "https://example.com/rest/api/2/issuetype/3", + "id": "3", + "name": "Task", + "subtask": false, + "statuses": [ + { + "self": "https://example.com/rest/api/2/status/1", + "description": "The issue is open and ready for the assignee to start work on it.", + "iconUrl": "https://example.com/images/icons/statuses/open.png", + "name": "Open", + "id": "1", + "statusCategory": { + "self": "https://example.com/rest/api/2/statuscategory/2", + "id": 2, + "key": "new", + "colorName": "blue-gray", + "name": "To Do" + } + }, +... +``` diff --git a/doc/man/git-bug-add.1 b/doc/man/git-bug-add.1 index 2d47f0ac..9b0e6ec7 100644 --- a/doc/man/git-bug-add.1 +++ b/doc/man/git-bug-add.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,19 +20,19 @@ Create a new bug. .SH OPTIONS .PP \fB\-t\fP, \fB\-\-title\fP="" - Provide a title to describe the issue + Provide a title to describe the issue .PP \fB\-m\fP, \fB\-\-message\fP="" - Provide a message to describe the issue + Provide a message to describe the issue .PP \fB\-F\fP, \fB\-\-file\fP="" - Take the message from the given file. Use \- to read the message from the standard input + Take the message from the given file. Use \- to read the message from the standard input .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for add + help for add .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-auth-add-token.1 b/doc/man/git-bug-bridge-auth-add-token.1 index c9ca55d6..fe4750b4 100644 --- a/doc/man/git-bug-bridge-auth-add-token.1 +++ b/doc/man/git-bug-bridge-auth-add-token.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-bridge\-auth\-add\-token \- Store a new token .SH SYNOPSIS .PP -\fBgit\-bug bridge auth add\-token [<token>] [flags]\fP +\fBgit\-bug bridge auth add\-token [] [flags]\fP .SH DESCRIPTION @@ -21,19 +20,19 @@ Store a new token .SH OPTIONS .PP \fB\-t\fP, \fB\-\-target\fP="" - The target of the bridge. Valid values are [github,gitlab,launchpad\-preview] + The target of the bridge. Valid values are [github,gitlab,jira,launchpad\-preview] .PP \fB\-l\fP, \fB\-\-login\fP="" - The login in the remote bug\-tracker + The login in the remote bug\-tracker .PP \fB\-u\fP, \fB\-\-user\fP="" - The user to add the token to. Default is the current user + The user to add the token to. Default is the current user .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for add\-token + help for add\-token .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-auth-rm.1 b/doc/man/git-bug-bridge-auth-rm.1 index b0222b72..9ddac3f2 100644 --- a/doc/man/git-bug-bridge-auth-rm.1 +++ b/doc/man/git-bug-bridge-auth-rm.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-bridge\-auth\-rm \- Remove a credential. .SH SYNOPSIS .PP -\fBgit\-bug bridge auth rm <id> [flags]\fP +\fBgit\-bug bridge auth rm [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Remove a credential. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for rm + help for rm .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-auth-show.1 b/doc/man/git-bug-bridge-auth-show.1 index 6e0d345c..ae5d2039 100644 --- a/doc/man/git-bug-bridge-auth-show.1 +++ b/doc/man/git-bug-bridge-auth-show.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ Display an authentication credential. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for show + help for show .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-auth.1 b/doc/man/git-bug-bridge-auth.1 index 0e400c41..02f2ca0f 100644 --- a/doc/man/git-bug-bridge-auth.1 +++ b/doc/man/git-bug-bridge-auth.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ List all known bridge authentication credentials. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for auth + help for auth .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-configure.1 index d1dc9f7d..cc66487f 100644 --- a/doc/man/git-bug-bridge-configure.1 +++ b/doc/man/git-bug-bridge-configure.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -19,8 +18,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 @@ -29,43 +26,47 @@ Token configuration can be directly passed with the \-\-token flag or in the ter .SH OPTIONS .PP \fB\-n\fP, \fB\-\-name\fP="" - A distinctive name to identify the bridge + A distinctive name to identify the bridge .PP \fB\-t\fP, \fB\-\-target\fP="" - The target of the bridge. Valid values are [github,gitlab,launchpad\-preview] + The target of the bridge. Valid values are [github,gitlab,jira,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 + 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] - help for configure + help for configure .SH EXAMPLE @@ -75,7 +76,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/man/git-bug-bridge-pull.1 b/doc/man/git-bug-bridge-pull.1 index c6614627..055d2472 100644 --- a/doc/man/git-bug-bridge-pull.1 +++ b/doc/man/git-bug-bridge-pull.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-bridge\-pull \- Pull updates. .SH SYNOPSIS .PP -\fBgit\-bug bridge pull [<name>] [flags]\fP +\fBgit\-bug bridge pull [] [flags]\fP .SH DESCRIPTION @@ -21,15 +20,15 @@ Pull updates. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for pull + help for pull .PP \fB\-n\fP, \fB\-\-no\-resume\fP[=false] - force importing all bugs + force importing all bugs .PP \fB\-s\fP, \fB\-\-since\fP="" - import only bugs updated after the given date (ex: "200h" or "june 2 2019") + import only bugs updated after the given date (ex: "200h" or "june 2 2019") .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-push.1 b/doc/man/git-bug-bridge-push.1 index 1257781b..59e60bdf 100644 --- a/doc/man/git-bug-bridge-push.1 +++ b/doc/man/git-bug-bridge-push.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-bridge\-push \- Push updates. .SH SYNOPSIS .PP -\fBgit\-bug bridge push [<name>] [flags]\fP +\fBgit\-bug bridge push [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Push updates. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for push + help for push .SH SEE ALSO diff --git a/doc/man/git-bug-bridge-rm.1 b/doc/man/git-bug-bridge-rm.1 index 324d4237..8cfa925a 100644 --- a/doc/man/git-bug-bridge-rm.1 +++ b/doc/man/git-bug-bridge-rm.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,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 @@ -21,7 +20,7 @@ Delete a configured bridge. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for rm + help for rm .SH SEE ALSO diff --git a/doc/man/git-bug-bridge.1 b/doc/man/git-bug-bridge.1 index 8e885f10..8d5c7dc0 100644 --- a/doc/man/git-bug-bridge.1 +++ b/doc/man/git-bug-bridge.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ Configure and use bridges to other bug trackers. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for bridge + help for bridge .SH SEE ALSO diff --git a/doc/man/git-bug-commands.1 b/doc/man/git-bug-commands.1 index dec359f5..b7c1e214 100644 --- a/doc/man/git-bug-commands.1 +++ b/doc/man/git-bug-commands.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-commands \- Display available commands. .SH SYNOPSIS .PP -\fBgit\-bug commands [<option>\&...] [flags]\fP +\fBgit\-bug commands [\&...] [flags]\fP .SH DESCRIPTION @@ -21,11 +20,11 @@ Display available commands. .SH OPTIONS .PP \fB\-p\fP, \fB\-\-pretty\fP[=false] - Output the command description as well as Markdown compatible comment + Output the command description as well as Markdown compatible comment .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for commands + help for commands .SH SEE ALSO diff --git a/doc/man/git-bug-comment-add.1 b/doc/man/git-bug-comment-add.1 index c25177a2..530101b8 100644 --- a/doc/man/git-bug-comment-add.1 +++ b/doc/man/git-bug-comment-add.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-comment\-add \- Add a new comment to a bug. .SH SYNOPSIS .PP -\fBgit\-bug comment add [<id>] [flags]\fP +\fBgit\-bug comment add [] [flags]\fP .SH DESCRIPTION @@ -21,15 +20,15 @@ Add a new comment to a bug. .SH OPTIONS .PP \fB\-F\fP, \fB\-\-file\fP="" - Take the message from the given file. Use \- to read the message from the standard input + Take the message from the given file. Use \- to read the message from the standard input .PP \fB\-m\fP, \fB\-\-message\fP="" - Provide the new message from the command line + Provide the new message from the command line .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for add + help for add .SH SEE ALSO diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-comment.1 index d70d7078..9beb7a06 100644 --- a/doc/man/git-bug-comment.1 +++ b/doc/man/git-bug-comment.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-comment \- Display or add comments to a bug. .SH SYNOPSIS .PP -\fBgit\-bug comment [<id>] [flags]\fP +\fBgit\-bug comment [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Display or add comments to a bug. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for comment + help for comment .SH SEE ALSO diff --git a/doc/man/git-bug-deselect.1 b/doc/man/git-bug-deselect.1 index 61536493..7cdf5112 100644 --- a/doc/man/git-bug-deselect.1 +++ b/doc/man/git-bug-deselect.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ Clear the implicitly selected bug. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for deselect + help for deselect .SH EXAMPLE diff --git a/doc/man/git-bug-label-add.1 b/doc/man/git-bug-label-add.1 index 893edbcc..86a4bb24 100644 --- a/doc/man/git-bug-label-add.1 +++ b/doc/man/git-bug-label-add.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-label\-add \- Add a label to a bug. .SH SYNOPSIS .PP -\fBgit\-bug label add [<id>] <label>[...] [flags]\fP +\fBgit\-bug label add [] [...] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Add a label to a bug. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for add + help for add .SH SEE ALSO diff --git a/doc/man/git-bug-label-rm.1 b/doc/man/git-bug-label-rm.1 index 3cc76b82..e7e912ea 100644 --- a/doc/man/git-bug-label-rm.1 +++ b/doc/man/git-bug-label-rm.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-label\-rm \- Remove a label from a bug. .SH SYNOPSIS .PP -\fBgit\-bug label rm [<id>] <label>[...] [flags]\fP +\fBgit\-bug label rm [] [...] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Remove a label from a bug. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for rm + help for rm .SH SEE ALSO diff --git a/doc/man/git-bug-label.1 b/doc/man/git-bug-label.1 index 14014227..23fc0047 100644 --- a/doc/man/git-bug-label.1 +++ b/doc/man/git-bug-label.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-label \- Display, add or remove labels to/from a bug. .SH SYNOPSIS .PP -\fBgit\-bug label [<id>] [flags]\fP +\fBgit\-bug label [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Display, add or remove labels to/from a bug. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for label + help for label .SH SEE ALSO diff --git a/doc/man/git-bug-ls-id.1 b/doc/man/git-bug-ls-id.1 index 5962f1b9..c7b40114 100644 --- a/doc/man/git-bug-ls-id.1 +++ b/doc/man/git-bug-ls-id.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-ls\-id \- List bug identifiers. .SH SYNOPSIS .PP -\fBgit\-bug ls\-id [<prefix>] [flags]\fP +\fBgit\-bug ls\-id [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ List bug identifiers. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for ls\-id + help for ls\-id .SH SEE ALSO diff --git a/doc/man/git-bug-ls-label.1 b/doc/man/git-bug-ls-label.1 index c5b7a807..30e63f94 100644 --- a/doc/man/git-bug-ls-label.1 +++ b/doc/man/git-bug-ls-label.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -24,7 +23,7 @@ Note: in the future, a proper label policy could be implemented where valid labe .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for ls\-label + help for ls\-label .SH SEE ALSO diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-ls.1 index aae57c1d..2fc1d337 100644 --- a/doc/man/git-bug-ls.1 +++ b/doc/man/git-bug-ls.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-ls \- List bugs. .SH SYNOPSIS .PP -\fBgit\-bug ls [<query>] [flags]\fP +\fBgit\-bug ls [] [flags]\fP .SH DESCRIPTION @@ -24,43 +23,43 @@ You can pass an additional query to filter and order the list. This query can be .SH OPTIONS .PP \fB\-s\fP, \fB\-\-status\fP=[] - Filter by status. Valid values are [open,closed] + Filter by status. Valid values are [open,closed] .PP \fB\-a\fP, \fB\-\-author\fP=[] - Filter by author + Filter by author .PP \fB\-p\fP, \fB\-\-participant\fP=[] - Filter by participant + Filter by participant .PP \fB\-A\fP, \fB\-\-actor\fP=[] - Filter by actor + Filter by actor .PP \fB\-l\fP, \fB\-\-label\fP=[] - Filter by label + Filter by label .PP \fB\-t\fP, \fB\-\-title\fP=[] - Filter by title + Filter by title .PP \fB\-n\fP, \fB\-\-no\fP=[] - Filter by absence of something. Valid values are [label] + Filter by absence of something. Valid values are [label] .PP \fB\-b\fP, \fB\-\-by\fP="creation" - Sort the results by a characteristic. Valid values are [id,creation,edit] + Sort the results by a characteristic. Valid values are [id,creation,edit] .PP \fB\-d\fP, \fB\-\-direction\fP="asc" - Select the sorting direction. Valid values are [asc,desc] + Select the sorting direction. Valid values are [asc,desc] .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for ls + help for ls .SH EXAMPLE diff --git a/doc/man/git-bug-pull.1 b/doc/man/git-bug-pull.1 index 5690c80a..82b741ed 100644 --- a/doc/man/git-bug-pull.1 +++ b/doc/man/git-bug-pull.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-pull \- Pull bugs update from a git remote. .SH SYNOPSIS .PP -\fBgit\-bug pull [<remote>] [flags]\fP +\fBgit\-bug pull [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Pull bugs update from a git remote. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for pull + help for pull .SH SEE ALSO diff --git a/doc/man/git-bug-push.1 b/doc/man/git-bug-push.1 index defa06c9..dc694258 100644 --- a/doc/man/git-bug-push.1 +++ b/doc/man/git-bug-push.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-push \- Push bugs update to a git remote. .SH SYNOPSIS .PP -\fBgit\-bug push [<remote>] [flags]\fP +\fBgit\-bug push [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Push bugs update to a git remote. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for push + help for push .SH SEE ALSO diff --git a/doc/man/git-bug-select.1 b/doc/man/git-bug-select.1 index 36728037..4df61221 100644 --- a/doc/man/git-bug-select.1 +++ b/doc/man/git-bug-select.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-select \- Select a bug for implicit use in future commands. .SH SYNOPSIS .PP -\fBgit\-bug select <id> [flags]\fP +\fBgit\-bug select [flags]\fP .SH DESCRIPTION @@ -18,7 +17,7 @@ git\-bug\-select \- Select a bug for implicit use in future commands. Select a bug for implicit use in future commands. .PP -This command allows you to omit any bug <id> argument, for example: +This command allows you to omit any bug argument, for example: git bug show instead of git bug show 2f153ca @@ -30,7 +29,7 @@ The complementary command is "git bug deselect" performing the opposite operatio .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for select + help for select .SH EXAMPLE diff --git a/doc/man/git-bug-show.1 b/doc/man/git-bug-show.1 index 9ad9c019..dae1877b 100644 --- a/doc/man/git-bug-show.1 +++ b/doc/man/git-bug-show.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-show \- Display the details of a bug. .SH SYNOPSIS .PP -\fBgit\-bug show [<id>] [flags]\fP +\fBgit\-bug show [] [flags]\fP .SH DESCRIPTION @@ -21,11 +20,11 @@ Display the details of a bug. .SH OPTIONS .PP \fB\-f\fP, \fB\-\-field\fP="" - Select field to display. Valid values are [author,authorEmail,createTime,humanId,id,labels,shortId,status,title,actors,participants] + Select field to display. Valid values are [author,authorEmail,createTime,humanId,id,labels,shortId,status,title,actors,participants] .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for show + help for show .SH SEE ALSO diff --git a/doc/man/git-bug-status-close.1 b/doc/man/git-bug-status-close.1 index 71824337..539c5447 100644 --- a/doc/man/git-bug-status-close.1 +++ b/doc/man/git-bug-status-close.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-status\-close \- Mark a bug as closed. .SH SYNOPSIS .PP -\fBgit\-bug status close [<id>] [flags]\fP +\fBgit\-bug status close [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Mark a bug as closed. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for close + help for close .SH SEE ALSO diff --git a/doc/man/git-bug-status-open.1 b/doc/man/git-bug-status-open.1 index 06c41368..d7aca0d0 100644 --- a/doc/man/git-bug-status-open.1 +++ b/doc/man/git-bug-status-open.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-status\-open \- Mark a bug as open. .SH SYNOPSIS .PP -\fBgit\-bug status open [<id>] [flags]\fP +\fBgit\-bug status open [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Mark a bug as open. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for open + help for open .SH SEE ALSO diff --git a/doc/man/git-bug-status.1 b/doc/man/git-bug-status.1 index 36901a51..df013911 100644 --- a/doc/man/git-bug-status.1 +++ b/doc/man/git-bug-status.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-status \- Display or change a bug status. .SH SYNOPSIS .PP -\fBgit\-bug status [<id>] [flags]\fP +\fBgit\-bug status [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Display or change a bug status. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for status + help for status .SH SEE ALSO diff --git a/doc/man/git-bug-termui.1 b/doc/man/git-bug-termui.1 index 01de82fa..f8ccc42a 100644 --- a/doc/man/git-bug-termui.1 +++ b/doc/man/git-bug-termui.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ Launch the terminal UI. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for termui + help for termui .SH SEE ALSO diff --git a/doc/man/git-bug-title-edit.1 b/doc/man/git-bug-title-edit.1 index 4382a20e..c1903854 100644 --- a/doc/man/git-bug-title-edit.1 +++ b/doc/man/git-bug-title-edit.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-title\-edit \- Edit a title of a bug. .SH SYNOPSIS .PP -\fBgit\-bug title edit [<id>] [flags]\fP +\fBgit\-bug title edit [] [flags]\fP .SH DESCRIPTION @@ -21,11 +20,11 @@ Edit a title of a bug. .SH OPTIONS .PP \fB\-t\fP, \fB\-\-title\fP="" - Provide a title to describe the issue + Provide a title to describe the issue .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for edit + help for edit .SH SEE ALSO diff --git a/doc/man/git-bug-title.1 b/doc/man/git-bug-title.1 index f58cc3c1..e3345acd 100644 --- a/doc/man/git-bug-title.1 +++ b/doc/man/git-bug-title.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-title \- Display or change a title of a bug. .SH SYNOPSIS .PP -\fBgit\-bug title [<id>] [flags]\fP +\fBgit\-bug title [] [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Display or change a title of a bug. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for title + help for title .SH SEE ALSO diff --git a/doc/man/git-bug-user-adopt.1 b/doc/man/git-bug-user-adopt.1 index b3bc07c0..2be2afcb 100644 --- a/doc/man/git-bug-user-adopt.1 +++ b/doc/man/git-bug-user-adopt.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-user\-adopt \- Adopt an existing identity as your own. .SH SYNOPSIS .PP -\fBgit\-bug user adopt <user-id> [flags]\fP +\fBgit\-bug user adopt [flags]\fP .SH DESCRIPTION @@ -21,7 +20,7 @@ Adopt an existing identity as your own. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for adopt + help for adopt .SH SEE ALSO diff --git a/doc/man/git-bug-user-create.1 b/doc/man/git-bug-user-create.1 index f31b7369..099a44bd 100644 --- a/doc/man/git-bug-user-create.1 +++ b/doc/man/git-bug-user-create.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ Create a new identity. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for create + help for create .SH SEE ALSO diff --git a/doc/man/git-bug-user-ls.1 b/doc/man/git-bug-user-ls.1 index 30de5fb6..1ccddb8a 100644 --- a/doc/man/git-bug-user-ls.1 +++ b/doc/man/git-bug-user-ls.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,7 +20,7 @@ List identities. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for ls + help for ls .SH SEE ALSO diff --git a/doc/man/git-bug-user.1 b/doc/man/git-bug-user.1 index dc04cee8..5a4cf439 100644 --- a/doc/man/git-bug-user.1 +++ b/doc/man/git-bug-user.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -10,7 +9,7 @@ git\-bug\-user \- Display or change the user identity. .SH SYNOPSIS .PP -\fBgit\-bug user [<user-id>] [flags]\fP +\fBgit\-bug user [] [flags]\fP .SH DESCRIPTION @@ -21,11 +20,11 @@ Display or change the user identity. .SH OPTIONS .PP \fB\-f\fP, \fB\-\-field\fP="" - Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamport,login,metadata,name] + Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamport,login,metadata,name] .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for user + help for user .SH SEE ALSO diff --git a/doc/man/git-bug-version.1 b/doc/man/git-bug-version.1 index 8660417f..963e260e 100644 --- a/doc/man/git-bug-version.1 +++ b/doc/man/git-bug-version.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -21,19 +20,19 @@ Show git\-bug version information. .SH OPTIONS .PP \fB\-n\fP, \fB\-\-number\fP[=false] - Only show the version number + Only show the version number .PP \fB\-c\fP, \fB\-\-commit\fP[=false] - Only show the commit hash + Only show the commit hash .PP \fB\-a\fP, \fB\-\-all\fP[=false] - Show all version informations + Show all version informations .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for version + help for version .SH SEE ALSO diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 9bcb65fd..62d2e5dc 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -25,19 +24,19 @@ Available git config: .SH OPTIONS .PP \fB\-\-open\fP[=false] - Automatically open the web UI in the default browser + Automatically open the web UI in the default browser .PP \fB\-\-no\-open\fP[=false] - Prevent the automatic opening of the web UI in the default browser + Prevent the automatic opening of the web UI in the default browser .PP \fB\-p\fP, \fB\-\-port\fP=0 - Port to listen to (default is random) + Port to listen to (default is random) .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for webui + help for webui .SH SEE ALSO diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1 index 4008ac0d..6dba279e 100644 --- a/doc/man/git-bug.1 +++ b/doc/man/git-bug.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -26,7 +25,7 @@ the same git remote your are already using to collaborate with other peoples. .SH OPTIONS .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for git\-bug + help for git\-bug .SH SEE ALSO diff --git a/doc/md/git-bug_bridge_auth_add-token.md b/doc/md/git-bug_bridge_auth_add-token.md index 496455a0..f0f8ac72 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,launchpad-preview] + -t, --target string The target of the bridge. Valid values are [github,gitlab,jira,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 c0f89cf3..f89de404 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,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,jira,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 ``` |