aboutsummaryrefslogtreecommitdiffstats
path: root/doc/git-sugpatch.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/git-sugpatch.1.txt')
-rw-r--r--doc/git-sugpatch.1.txt70
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/git-sugpatch.1.txt b/doc/git-sugpatch.1.txt
new file mode 100644
index 0000000..d303559
--- /dev/null
+++ b/doc/git-sugpatch.1.txt
@@ -0,0 +1,70 @@
+git-sugpatch(1)
+===============
+
+NAME
+----
+git-sugpatch - Show diffs for GitHub suggestions
+
+SYNOPSIS
+--------
+'git sugpatch' [options] <suggestion>...
+
+DESCRIPTION
+-----------
+Show the diffs of the given GitHub suggestion references.
+
+A suggestion reference is either a URL to the comment, or its ID.
+
+OPTIONS
+-------
+--github-token::
+ A GitHub API token with the “repo” permission. This can also be set
+ with `githubSuggestion.githubToken` or the `GITHUB_TOKEN`
+ environment variable.
+
+-h, --help::
+ Print usage help.
+
+--remote::
+ 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`.
+
+-V, --version::
+ Print the program version.
+
+CONFIGURATION
+-------------
+Configuration options can be specified either as command line options,
+or in the Git config.
+
+githubSuggestion.githubToken::
+ A GitHub API token with the “repo” permission. This can also be set
+ with the `GITHUB_TOKEN` environment variable.
+
+githubSuggestion.remote::
+ The remote to use to fetch the suggestion from when passing a
+ suggestion ID. Defaults to `origin`.
+
+ENVIRONMENT VARIABLES
+---------------------
+GITHUB_TOKEN::
+ A GitHub API token with the “repo” permission.
+
+EXAMPLES
+--------
+Suggestion references can be specified either as URLs:
+
+ $ git sugpatch https://github.com/teddywing/github-suggestion/pull/1#discussion_r459691747
+
+or as comment IDs:
+
+ $ git sugpatch 459692838
+
+They can also be mixed:
+
+ $ git sugpatch 459692838 https://github.com/teddywing/github-suggestion/pull/1#discussion_r459691747
+
+SEE ALSO
+--------
+git-sugapply(1)