doc/git-sugdiff.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

'\" t
.\"     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/30/2020
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "GIT\-SUGDIFF" "1" "08/30/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-sugdiff \- Show diffs for GitHub suggestions
.SH "SYNOPSIS"
.sp
\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
A GitHub API token with the \(lqrepo\(rq permission\&. This can also be set with
\fBgithubSuggestion\&.githubToken\fR
or the
\fBGITHUB_TOKEN\fR
environment variable\&.
.RE
.PP
\-h, \-\-help
.RS 4
Print usage help\&.
.RE
.PP
\-\-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
\fBorigin\fR\&.
.RE
.PP
\-V, \-\-version
.RS 4
Print the program version\&.
.RE
.SH "CONFIGURATION"
.sp
Configuration options can be specified either as command line options, or in the Git config\&. Command line options take precedence\&.
.PP
githubSuggestion\&.githubToken
.RS 4
A GitHub API token with the \(lqrepo\(rq permission\&. This will override the
\fBGITHUB_TOKEN\fR
environment variable\&.
.RE
.PP
githubSuggestion\&.remote
.RS 4
The remote to use to fetch the suggestion from when passing a suggestion ID\&. Defaults to
\fBorigin\fR\&.
.RE
.SH "ENVIRONMENT VARIABLES"
.PP
GITHUB_TOKEN
.RS 4
A GitHub API token with the \(lqrepo\(rq permission\&.
.RE
.SH "EXAMPLES"
.sp
Suggestion references can be specified either as URLs:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git sugdiff https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747
.fi
.if n \{\
.RE
.\}
.sp
or as comment IDs:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git sugdiff 459691747
.fi
.if n \{\
.RE
.\}
.sp
They can also be mixed:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git sugdiff 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
git\-sugapply(1)