push doc: correct lies about how push refspecs work

There's complex rules governing whether a push is allowed to take place depending on whether we're pushing to refs/heads/*, refs/tags/* or refs/not-that/*. See is_branch() in refs.c, and the various assertions in refs/files-backend.c. (e.g. "trying to write non-commit object %s to branch '%s'"). This documentation has never been quite correct, but went downhill after dbfeddb12e ("push: require force for refs under refs/tags/", 2012-11-29) when we started claiming that <dst> couldn't be a tag object, which is incorrect. After some of the logic in that patch was changed in 256b9d70a4 ("push: fix "refs/tags/ hierarchy cannot be updated without --force"", 2013-01-16) the docs weren't updated, and we've had some version of documentation that confused whether <src> was a tag or not with whether <dst> would accept either an annotated tag object or the commit it points to. This makes the intro somewhat more verbose & complex, perhaps we should have a shorter description here and split the full complexity into a dedicated section. Very few users will find themselves needing to e.g. push blobs or trees to refs/custom-namespace/* (or blobs or trees at all), and that could be covered separately as an advanced topic. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Aug 31, 2018 at 20:10 UTC fe802bd21e81cceedff2db79cc3c9a5ad75b4f93
2 files changed +48 -11
Documentation/git-push.txt
+44 -8
@@ -74,14 +74,50 @@ without any `<refspec>` on the command line. Otherwise, missing
74 `:<dst>` means to update the same ref as the `<src>`.
75 +
76 The object referenced by <src> is used to update the <dst> reference
77 -on the remote side. By default this is only allowed if <dst> is not
78 -a tag (annotated or lightweight), and then only if it can fast-forward
79 -<dst>. By having the optional leading `+`, you can tell Git to update
80 -the <dst> ref even if it is not allowed by default (e.g., it is not a
81 -fast-forward.).
82 -+
83 -Pushing an empty <src> allows you to delete the <dst> ref from
84 -the remote repository.
77 +on the remote side. Whether this is allowed depends on where in
78 +`refs/*` the <dst> reference lives as described in detail below, in
79 +those sections "update" means any modifications except deletes, which
80 +as noted after the next few sections are treated differently.
81 ++
82 +The `refs/heads/*` namespace will only accept commit objects, and
83 +updates only if they can be fast-forwarded.
84 ++
85 +The `refs/tags/*` namespace will accept any kind of object (as
86 +commits, trees and blobs can be tagged), and any updates to them will
87 +be rejected.
88 ++
89 +It's possible to push any type of object to any namespace outside of
90 +`refs/{tags,heads}/*`. In the case of tags and commits, these will be
91 +treated as if they were the commits inside `refs/heads/*` for the
92 +purposes of whether the update is allowed.
93 ++
94 +I.e. a fast-forward of commits and tags outside `refs/{tags,heads}/*`
95 +is allowed, even in cases where what's being fast-forwarded is not a
96 +commit, but a tag object which happens to point to a new commit which
97 +is a fast-forward of the commit the last tag (or commit) it's
98 +replacing. Replacing a tag with an entirely different tag is also
99 +allowed, if it points to the same commit, as well as pushing a peeled
100 +tag, i.e. pushing the commit that existing tag object points to, or a
101 +new tag object which an existing commit points to.
102 ++
103 +Tree and blob objects outside of `refs/{tags,heads}/*` will be treated
104 +the same way as if they were inside `refs/tags/*`, any update of them
105 +will be rejected.
106 ++
107 +All of the rules described above about what's not allowed as an update
108 +can be overridden by adding an the optional leading `+` to a refspec
109 +(or using `--force` command line option). The only exception to this
110 +is that no amount of forcing will make the `refs/heads/*` namespace
111 +accept a non-commit object. Hooks and configuration can also override
112 +or amend these rules, see e.g. `receive.denyNonFastForwards` in
113 +linkgit:git-config[1] and`pre-receive` and `update` in
114 +linkgit:githooks[5].
115 ++
116 +Pushing an empty <src> allows you to delete the <dst> ref from the
117 +remote repository. Deletions are always accepted without a leading `+`
118 +in the refspec (or `--force`), except when forbidden by configuration
119 +or hooks. See `receive.denyDeletes` in linkgit:git-config[1] and
120 +`pre-receive` and `update` in linkgit:githooks[5].
121 +
122 The special refspec `:` (or `+:` to allow non-fast-forward updates)
123 directs Git to push "matching" branches: for every branch that exists on
Documentation/gitrevisions.txt
+4 -3
@@ -19,9 +19,10 @@ walk the revision graph (such as linkgit:git-log[1]), all commits which are
19 reachable from that commit. For commands that walk the revision graph one can
20 also specify a range of revisions explicitly.
21
22 -In addition, some Git commands (such as linkgit:git-show[1]) also take
23 -revision parameters which denote other objects than commits, e.g. blobs
24 -("files") or trees ("directories of files").
22 +In addition, some Git commands (such as linkgit:git-show[1] and
23 +linkgit:git-push[1]) can also take revision parameters which denote
24 +other objects than commits, e.g. blobs ("files") or trees
25 +("directories of files").
26
27 include::revisions.txt[]
28