diff options
author | Ævar Arnfjörð Bjarmason <avarab@gmail.com> | 2018-09-03 14:49:22 +0000 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2018-09-12 15:17:46 -0700 |
commit | f706c42bab5a2ac4af45e0df7853af1fc5346c45 (patch) | |
tree | 3b512ce92cec0f35b2cd297365507cb4ed78b4a5 /Documentation/config.txt | |
parent | 58dc440b3cd34db29b54e87ef80e0da8cd507445 (diff) | |
download | git-f706c42bab5a2ac4af45e0df7853af1fc5346c45.tar.gz |
fsck: document and test commented & empty line skipList input
There is currently no comment syntax for the fsck.skipList, this isn't
really by design, and it would be nice to have support for comments.
Document that this doesn't work, and test for how this errors
out. These tests reveal a current bug, if there's invalid input the
output will emit some of the next line, and then go into uninitialized
memory. This is fixed in a subsequent change.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config.txt')
-rw-r--r-- | Documentation/config.txt | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index fd1b5837d0..0e1ce7de8b 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -1712,10 +1712,13 @@ will only cause git to warn. fsck.skipList:: The path to a list of object names (i.e. one SHA-1 per line) that are known to be broken in a non-fatal way and should - be ignored. This feature is useful when an established project - should be accepted despite early commits containing errors that - can be safely ignored such as invalid committer email addresses. - Note: corrupt objects cannot be skipped with this setting. + be ignored. Comments ('#') and empty lines are not supported, and + will error out. ++ +This feature is useful when an established project should be accepted +despite early commits containing errors that can be safely ignored +such as invalid committer email addresses. Note: corrupt objects +cannot be skipped with this setting. + Like `fsck.<msg-id>` this variable has corresponding `receive.fsck.skipList` and `fetch.fsck.skipList` variants. |