Documentation/git-update-ref.txt: demote symlink to last section
Move the discussion of file system symbolic links to a new “Notes” section (inspired by the one in git-symbolic-ref(1)) since this is mostly of historical note at this point, not something that is needed in the main section of the documentation. Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Taylor Blau <me@ttaylorr.com>
Kristoffer Haugsbakk committed
Oct 21, 2024 at 22:47 UTC
dc6050f67e33c29c3b2787a6b1aa419e54f19d76
1 file changed
+11
-8
Documentation/git-update-ref.txt
+11
-8
@@ -29,14 +29,6 @@ It also allows a "ref" file to be a symbolic pointer to another
29
ref file by starting with the four-byte header sequence of
30
"ref:".
31
32
-More importantly, it allows the update of a ref file to follow
33
-these symbolic pointers, whether they are symlinks or these
34
-"regular file symbolic refs". It follows *real* symlinks only
35
-if they start with "refs/": otherwise it will just try to read
36
-them and update them as a regular file (i.e. it will allow the
37
-filesystem to follow them, but will overwrite such a symlink to
38
-somewhere else with a regular filename).
39
-
32
If --no-deref is given, <ref> itself is overwritten, rather than
33
the result of following the symbolic pointers.
34
@@ -185,6 +177,17 @@ An update will fail (without changing <ref>) if the current user is
177
unable to create a new log file, append to the existing log file
178
or does not have committer information available.
179
180
+NOTES
181
+-----
182
+
183
+Symbolic refs were initially implemented using symbolic links. This is
184
+now deprecated since not all filesystems support symbolic links.
185
+
186
+This command follows *real* symlinks only if they start with "refs/":
187
+otherwise it will just try to read them and update them as a regular
188
+file (i.e. it will allow the filesystem to follow them, but will
189
+overwrite such a symlink to somewhere else with a regular filename).
190
+
191
GIT
192
---
193
Part of the linkgit:git[1] suite