aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2020-08-30 04:27:39 +0200
committerTeddy Wing2020-08-30 04:27:39 +0200
commit436c09d6484b657056db07f68b11da116bbd0307 (patch)
tree7d3849a5ae3fac6d4d073434140b3990a846f91e
parent118d466716ca688e3d1f5857cf8ea35b23c8e704 (diff)
downloadgit-suggestion-436c09d6484b657056db07f68b11da116bbd0307.tar.bz2
doc/git-sugdiff.1: Add a note about Git diff option support
Not sure if I should be emphasising this more.
-rw-r--r--doc/git-sugdiff.18
-rw-r--r--doc/git-sugdiff.1.txt4
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/git-sugdiff.1 b/doc/git-sugdiff.1
index 345b91c..1f386a0 100644
--- a/doc/git-sugdiff.1
+++ b/doc/git-sugdiff.1
@@ -2,12 +2,12 @@
.\" Title: git-sugdiff
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 08/23/2020
+.\" Date: 08/30/2020
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "GIT\-SUGDIFF" "1" "08/23/2020" "\ \&" "\ \&"
+.TH "GIT\-SUGDIFF" "1" "08/30/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -31,13 +31,15 @@
git-sugdiff \- Show diffs for GitHub suggestions
.SH "SYNOPSIS"
.sp
-\fIgit sugdiff\fR [options] <suggestion>\&...
+\fIgit sugdiff\fR [options] [git\-diff\-options] <suggestion>\&...
.SH "DESCRIPTION"
.sp
Show the diffs of the given GitHub suggestion references\&.
.sp
A suggestion reference is either a URL to the comment, or its ID\&.
.SH "OPTIONS"
+.sp
+All standard Git diff options are supported\&.
.PP
\-\-github\-token=<token>
.RS 4
diff --git a/doc/git-sugdiff.1.txt b/doc/git-sugdiff.1.txt
index 9960949..a596240 100644
--- a/doc/git-sugdiff.1.txt
+++ b/doc/git-sugdiff.1.txt
@@ -7,7 +7,7 @@ git-sugdiff - Show diffs for GitHub suggestions
SYNOPSIS
--------
-'git sugdiff' [options] <suggestion>...
+'git sugdiff' [options] [git-diff-options] <suggestion>...
DESCRIPTION
-----------
@@ -17,6 +17,8 @@ A suggestion reference is either a URL to the comment, or its ID.
OPTIONS
-------
+All standard Git diff options are supported.
+
--github-token=<token>::
A GitHub API token with the “repo” permission. This can also be set
with `githubSuggestion.githubToken` or the `GITHUB_TOKEN`