diff options
| author | Teddy Wing | 2020-08-23 20:55:08 +0200 |
|---|---|---|
| committer | Teddy Wing | 2020-08-23 20:55:08 +0200 |
| commit | 623f60844478a3cfc60d697f5e5d804254c01c50 (patch) | |
| tree | 981f8e57bc35fbc3022a58f7442a9e7f92926491 /doc/git-sugpatch.1.txt | |
| parent | bce2e554408404233b66f11e2e342d83c3ca81dd (diff) | |
| download | git-suggestion-623f60844478a3cfc60d697f5e5d804254c01c50.tar.bz2 | |
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.
Diffstat (limited to 'doc/git-sugpatch.1.txt')
| -rw-r--r-- | doc/git-sugpatch.1.txt | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/doc/git-sugpatch.1.txt b/doc/git-sugpatch.1.txt deleted file mode 100644 index c1513a4..0000000 --- a/doc/git-sugpatch.1.txt +++ /dev/null @@ -1,70 +0,0 @@ -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=<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=<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`. - --V, --version:: - Print the program version. - -CONFIGURATION -------------- -Configuration options can be specified either as command line options, -or in the Git config. Command line options take precedence. - -githubSuggestion.githubToken:: - A GitHub API token with the “repo” permission. This will override - 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/git-suggestion/pull/1#discussion_r459691747 - -or as comment IDs: - - $ git sugpatch 459691747 - -They can also be mixed: - - $ git sugpatch 459692838 https://github.com/teddywing/git-suggestion/pull/1#discussion_r459691747 - -SEE ALSO --------- -git-sugapply(1) |