githooks.txt: replace mentions of SHA-1 specific properties
The githooks(5) documentation states in several places that the hook will receive a SHA-1 or hashes of 40 characters length. Given that we're transitioning to a world where both SHA-1 and SHA-256 are supported, this is inaccurate. Fix the issue by replacing mentions of SHA-1 with "object name" and not explicitly mentioning the hash size. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Patrick Steinhardt committed
Mar 1, 2021 at 10:43 UTC
5f308a89d8c37a186d58beff88542df00bc67975
1 file changed
+11
-11
Documentation/githooks.txt
+11
-11
@@ -138,7 +138,7 @@ given); `template` (if a `-t` option was given or the
138
configuration option `commit.template` is set); `merge` (if the
139
commit is a merge or a `.git/MERGE_MSG` file exists); `squash`
140
(if a `.git/SQUASH_MSG` file exists); or `commit`, followed by
141
-a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).
141
+a commit object name (if a `-c`, `-C` or `--amend` option was given).
142
143
If the exit status is non-zero, `git commit` will abort.
144
@@ -231,19 +231,19 @@ named remote is not being used both values will be the same.
231
Information about what is to be pushed is provided on the hook's standard
232
input with lines of the form:
233
234
- <local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
234
+ <local ref> SP <local object name> SP <remote ref> SP <remote object name> LF
235
236
For instance, if the command +git push origin master:foreign+ were run the
237
hook would receive a line like the following:
238
239
refs/heads/master 67890 refs/heads/foreign 12345
240
241
-although the full, 40-character SHA-1s would be supplied. If the foreign ref
242
-does not yet exist the `<remote SHA-1>` will be 40 `0`. If a ref is to be
243
-deleted, the `<local ref>` will be supplied as `(delete)` and the `<local
244
-SHA-1>` will be 40 `0`. If the local commit was specified by something other
245
-than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be
246
-supplied as it was originally given.
241
+although the full object name would be supplied. If the foreign ref does not
242
+yet exist the `<remote object name>` will be the all-zeroes object name. If a
243
+ref is to be deleted, the `<local ref>` will be supplied as `(delete)` and the
244
+`<local object name>` will be the all-zeroes object name. If the local commit
245
+was specified by something other than a name which could be expanded (such as
246
+`HEAD~`, or an object name) it will be supplied as it was originally given.
247
248
If this hook exits with a non-zero status, `git push` will abort without
249
pushing anything. Information about why the push is rejected may be sent
@@ -268,7 +268,7 @@ input a line of the format:
268
where `<old-value>` is the old object name stored in the ref,
269
`<new-value>` is the new object name to be stored in the ref and
270
`<ref-name>` is the full name of the ref.
271
-When creating a new ref, `<old-value>` is 40 `0`.
271
+When creating a new ref, `<old-value>` is the all-zeroes object name.
272
273
If the hook exits with non-zero status, none of the refs will be
274
updated. If the hook exits with zero, updating of individual refs can
@@ -550,7 +550,7 @@ command-dependent arguments may be passed in the future.
550
The hook receives a list of the rewritten commits on stdin, in the
551
format
552
553
- <old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
553
+ <old-object-name> SP <new-object-name> [ SP <extra-info> ] LF
554
555
The 'extra-info' is again command-dependent. If it is empty, the
556
preceding SP is also omitted. Currently, no commands pass any
@@ -566,7 +566,7 @@ rebase::
566
For the 'squash' and 'fixup' operation, all commits that were
567
squashed are listed as being rewritten to the squashed commit.
568
This means that there will be several lines sharing the same
569
- 'new-sha1'.
569
+ 'new-object-name'.
570
+
571
The commits are guaranteed to be listed in the order that they were
572
processed by rebase.