git-fast-export.adoc: clarify why 'verbatim' may not be a good idea
Signed-off-by: Luke Shumaker <lukeshu@datawire.io> Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Luke Shumaker committed
Mar 10, 2025 at 16:57 UTC
87f2a9195e7bea721d9cffe98383b4065d233f66
1 file changed
+8
-3
Documentation/git-fast-export.adoc
+8
-3
@@ -29,15 +29,20 @@ OPTIONS
29
30
--signed-tags=(verbatim|warn-verbatim|warn-strip|strip|abort)::
31
Specify how to handle signed tags. Since any transformation
32
- after the export can change the tag names (which can also happen
33
- when excluding revisions) the signatures will not match.
32
+ after the export (or during the export, such as excluding
33
+ revisions) can change the hashes being signed, the signatures
34
+ may become invalid.
35
+
36
When asking to 'abort' (which is the default), this program will die
37
when encountering a signed tag. With 'strip', the tags will silently
38
be made unsigned, with 'warn-strip' they will be made unsigned but a
39
warning will be displayed, with 'verbatim', they will be silently
40
exported and with 'warn-verbatim' (or 'warn', a deprecated synonym),
40
-they will be exported, but you will see a warning.
41
+they will be exported, but you will see a warning. 'verbatim' and
42
+'warn-verbatim' should only be used if you know that no transformation
43
+affecting tags or any commit in their history will be performed by you
44
+or by fast-export or fast-import, or if you do not care that the
45
+resulting tag will have an invalid signature.
46
47
--tag-of-filtered-object=(abort|drop|rewrite)::
48
Specify how to handle tags whose tagged object is filtered out.