aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2020-08-04 02:58:16 +0200
committerTeddy Wing2020-08-04 02:58:16 +0200
commitdf93ab6512be8752d124e119832e679058ffe630 (patch)
tree99aea31fd6dce247f7abc6f88dcc91dd2edc1e40
parentbe9bb4efb0bbf6c9b663030282d837deeedb94f8 (diff)
downloadgit-suggestion-df93ab6512be8752d124e119832e679058ffe630.tar.bz2
doc/git-sugpatch.1: Add values to command line options
Make it clear that these options require argument values.
-rw-r--r--doc/git-sugpatch.14
-rw-r--r--doc/git-sugpatch.1.txt4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/git-sugpatch.1 b/doc/git-sugpatch.1
index 07e4f4e..0a74b4c 100644
--- a/doc/git-sugpatch.1
+++ b/doc/git-sugpatch.1
@@ -39,7 +39,7 @@ Show the diffs of the given GitHub suggestion references\&.
A suggestion reference is either a URL to the comment, or its ID\&.
.SH "OPTIONS"
.PP
-\-\-github\-token
+\-\-github\-token=<token>
.RS 4
A GitHub API token with the \(lqrepo\(rq permission\&. This can also be set with
\fBgithubSuggestion\&.githubToken\fR
@@ -53,7 +53,7 @@ environment variable\&.
Print usage help\&.
.RE
.PP
-\-\-remote
+\-\-remote=<remote\-name>
.RS 4
The remote to use to fetch the suggestion from when passing a suggestion ID\&. This can also be set with
\fBgithubSuggestion\&.remote\fR\&. Defaults to
diff --git a/doc/git-sugpatch.1.txt b/doc/git-sugpatch.1.txt
index 8d31bba..5076f64 100644
--- a/doc/git-sugpatch.1.txt
+++ b/doc/git-sugpatch.1.txt
@@ -17,7 +17,7 @@ A suggestion reference is either a URL to the comment, or its ID.
OPTIONS
-------
---github-token::
+--github-token=<token>::
A GitHub API token with the “repo” permission. This can also be set
with `githubSuggestion.githubToken` or the `GITHUB_TOKEN`
environment variable.
@@ -25,7 +25,7 @@ OPTIONS
-h, --help::
Print usage help.
---remote::
+--remote=<remote-name>::
The remote to use to fetch the suggestion from when passing a
suggestion ID. This can also be set with `githubSuggestion.remote`.
Defaults to `origin`.