From c6ed77191026935655d8e1b40bbb1088a3ac8351 Mon Sep 17 00:00:00 2001 From: Michael Vrable Date: Tue, 15 Jul 2025 21:14:30 -0700 Subject: [PATCH] Fix documentation for the 'name' metadata field The metadata field for a file path is "name", but the format documentation incorrectly says it is "path". Original versions of Cumulus used "name". Commit 6c94114148c4 renamed this to "path" (and updated the documentation), but the naming change was later reverted in commit 03e760560aa7 (since the benefits weren't deemed worth the potential complexity of supporting both names). This happened between the v0.5.1 and v0.6 releases but was never in any released code. The naming revert updated code but forgot to revert the documentation change. Fix that. --- doc/format.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/format.txt b/doc/format.txt index 2c40075..75ebece 100644 --- a/doc/format.txt +++ b/doc/format.txt @@ -225,8 +225,9 @@ for each field is specified in the field listing that follows. and those starting with 0x are intepreted as hexadecimal. Common fields (required in all stanzas): - path [encoded string]: Full path of the file archived. Note: In - previous versions (<= 0.2) the name of this field was "name". + name [encoded string]: Full path of the file archived. Note: For + a brief period of time between versions 0.5.1 and 0.6 (but not + in any released version) this field was called "path". user [special]: The user ID of the file, as an integer, optionally followed by a space and the corresponding username, as an escaped string enclosed in parentheses. -- 2.20.1