undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dddecc5b7f
git-commit-vandalism/Documentation/git-patch-id.txt

36 lines
940 B
Plaintext
Raw Normal View History

Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
git-patch-id(1)
===============
NAME
----
Documentation: sync git.txt command list and manual page title Also reorders a handful entries to make each list sorted alphabetically. Signed-off-by: Junio C Hamano <junkio@cox.net>
2007-01-19 00:53:37 +01:00
git-patch-id - Compute unique ID for a patch
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
SYNOPSIS
--------
Documentation: use [verse] for SYNOPSIS sections The SYNOPSIS sections of most commands that span several lines already use [verse] to retain line breaks. Most commands that don't span several lines seem not to use [verse]. In the HTML output, [verse] does not only preserve line breaks, but also makes the section indented, which causes a slight inconsistency between commands that use [verse] and those that don't. Use [verse] in all SYNOPSIS sections for consistency. Also remove the blank lines from git-fetch.txt and git-rebase.txt to align with the other man pages. In the case of git-rebase.txt, which already uses [verse], the blank line makes the [verse] not apply to the last line, so removing the blank line also makes the formatting within the document more consistent. While at it, add single quotes to 'git cvsimport' for consistency with other commands. Signed-off-by: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-07-02 04:38:26 +02:00
[verse]
Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-30 08:09:04 +02:00
'git patch-id' < <patch>
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
DESCRIPTION
-----------
The name of the hash function is "SHA-1", not "SHA1" Use "SHA-1" instead of "SHA1" whenever we talk about the hash function. When used as a programming symbol, we keep "SHA1". Signed-off-by: Thomas Ackermann <th.acker@arcor.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-04-15 19:49:04 +02:00
A "patch ID" is nothing but a SHA-1 of the diff associated with a patch, with
[PATCH] Subject: [PATCH] Add some documentation. Add some documentation. Text taken from the the commit messages and the command sources.
2005-08-27 03:18:48 +02:00
whitespace and line numbers ignored. As such, it's "reasonably stable", but at
Documentation: Spelling fixes Signed-off-by: Horst H. von Brand <vonbrand@inf.utfsm.cl> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-06-03 22:27:26 +02:00
the same time also reasonably unique, i.e., two patches that have the same "patch
[PATCH] Subject: [PATCH] Add some documentation. Add some documentation. Text taken from the the commit messages and the command sources.
2005-08-27 03:18:48 +02:00
ID" are almost guaranteed to be the same thing.
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
[PATCH] Subject: [PATCH] Add some documentation. Add some documentation. Text taken from the the commit messages and the command sources.
2005-08-27 03:18:48 +02:00
IOW, you can use this thing to look for likely duplicate commits.
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
Documentation: spell 'git cmd' without dash throughout The documentation was quite inconsistent when spelling 'git cmd' if it only refers to the program, not to some specific invocation syntax: both 'git-cmd' and 'git cmd' spellings exist. The current trend goes towards dashless forms, and there is precedent in 647ac70 (git-svn.txt: stop using dash-form of commands., 2009-07-07) to actively eliminate the dashed variants. Replace 'git-cmd' with 'git cmd' throughout, except where git-shell, git-cvsserver, git-upload-pack, git-receive-pack, and git-upload-archive are concerned, because those really live in the $PATH.
2010-01-10 00:33:00 +01:00
When dealing with 'git diff-tree' output, it takes advantage of
Document git-patch-id a bit better. Pavel Roskin wondered what the SHA1 output at the beginning of git-diff-tree was about. The only consumer of that information so far is this git-patch-id command, which was inadequately documented. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 11:39:56 +02:00
the fact that the patch is prefixed with the object name of the
Grammar fixes to "merge" and "patch-id" docs Signed-off-by: Wincent Colaiuta <win@wincent.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-03-25 19:23:42 +01:00
commit, and outputs two 40-byte hexadecimal strings. The first
Document git-patch-id a bit better. Pavel Roskin wondered what the SHA1 output at the beginning of git-diff-tree was about. The only consumer of that information so far is this git-patch-id command, which was inadequately documented. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-28 11:39:56 +02:00
string is the patch ID, and the second string is the commit ID.
This can be used to make a mapping from patch ID to commit ID.
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
OPTIONS
-------
[PATCH] Subject: [PATCH] Add some documentation. Add some documentation. Text taken from the the commit messages and the command sources.
2005-08-27 03:18:48 +02:00
<patch>::
The diff to create the ID of.
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
GIT
---
documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-06-06 09:07:32 +02:00
Part of the linkgit:git[1] suite
Reference in New Issue Copy Permalink