[PATCH] bundle doc: 'verify' is not about verifying the bundle
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Mar 1, 2016, 21:36 UTC
- Message-ID
- <xmqqd1rd7uey.fsf@gitster.mtv.corp.google.com>
Even though the command does read the bundle header and checks to see if it looks reasonable, the thin-pack data stream that follows the header in the bundle file is not checked. More importantly, because the thin-pack data does not have a trailing checksum like on-disk packfiles do, there isn't much "verification" the command can do without unpacking the objects from the stream even if it wanted to.
The documentation gives an incorrect impression that the thin-pack data contained in the bundle is validated, but the command is to validate that the receiving repository is ready to accept the bundle, not to check the validity of a bundle file. Rephrase the paragraph to clarify this.
Signed-off-by: Junio C Hamano <gitster@pobox.com> --- Documentation/git-bundle.txt | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index 3a8120c..c0113a8 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -38,11 +38,10 @@ create <file>:: 'git-rev-list-args' arguments to define the bundle contents. verify <file>:: - Used to check that a bundle file is valid and will apply - cleanly to the current repository. This includes checks on the - bundle format itself as well as checking that the prerequisite - commits exist and are fully linked in the current repository. - 'git bundle' prints a list of missing commits, if any, and exits + Verifies that the given 'file' has a valid-looking bundle + header, and that your repository has all prerequisite + objects necessary to unpack the file as a bundle. The + command prints a list of missing commits, if any, and exits with a non-zero status. list-heads <file>::
-- 2.8.0-rc0-114-g0b3e5e5