From 623f60844478a3cfc60d697f5e5d804254c01c50 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sun, 23 Aug 2020 20:55:08 +0200
Subject: Rename `git-sugpatch` to `git-sugdiff`

The word "patch" reminds me more of the `patch` Unix command, which is
what `git-sugapply` does.

Since this command outputs diffs, it makes more sense to call it
`sugdiff`. That also brings these closer to the native Git commands,
`git-diff` and `git-apply`.

I had chosen "patch" originally because the command generated a unified
diff that could be used as a patch file to apply to the repo.
---
 doc/git-sugpatch.1 | 128 -----------------------------------------------------
 1 file changed, 128 deletions(-)
 delete mode 100644 doc/git-sugpatch.1

(limited to 'doc/git-sugpatch.1')

diff --git a/doc/git-sugpatch.1 b/doc/git-sugpatch.1
deleted file mode 100644
index 6f5ad15..0000000
--- a/doc/git-sugpatch.1
+++ /dev/null
@@ -1,128 +0,0 @@
-'\" t
-.\"     Title: git-sugpatch
-.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 08/06/2020
-.\"    Manual: \ \&
-.\"    Source: \ \&
-.\"  Language: English
-.\"
-.TH "GIT\-SUGPATCH" "1" "08/06/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-sugpatch \- Show diffs for GitHub suggestions
-.SH "SYNOPSIS"
-.sp
-\fIgit sugpatch\fR [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"
-.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 sugpatch 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 sugpatch 459691747
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-They can also be mixed:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-$ git sugpatch 459692838 https://github\&.com/teddywing/git\-suggestion/pull/1#discussion_r459691747
-.fi
-.if n \{\
-.RE
-.\}
-.SH "SEE ALSO"
-.sp
-git\-sugapply(1)
-- 
cgit v1.2.3