Re: [PATCH v2] archive: make --add-virtual-file honor --prefix

From: René Scharfe <l.s.r@web.de>
Date: May 19, 2024, 13:25 UTC
Message-ID: <bc3711a7-37d5-46bc-979e-83bd0b2cf900@web.de>
In-Reply-To: <pull.1719.v2.git.git.1715967267420.gitgitgadget@gmail.com>

Am 17.05.24 um 19:34 schrieb Tom Scogland via GitGitGadget:

Show 8 quoted lines

> From: Tom Scogland <scogland1@llnl.gov>
>
> The documentation for archive describes the `--add-virtual-file` option
> thusly:
>
>   The path of the file in the archive is built by concatenating the
>   value of the last `--prefix` moption (if any) before this
>   `--add-virtual-file` and <path>.

The documentation does not actually misspell "option" as "moption".

Show 15 quoted lines

> The `--add-file` documentation is similar:
>
>   The path of the file in the archive is built by concatenating the
>   value of the last --prefix option (if any) before this --add-file and
>   the basename of <file>.
>
> Notably both explicitly state that they honor the last `--prefix` option
> before the `--add` option in question.  The implementation of
> `--add-file` seems to have always honored prefix, but the implementation
> of `--add-virtual-file` does not.  Also note that `--add-virtual-file`
> explicitly states it will use the full path given, while `--add-file`
> uses the basename of the path it is given.
>
> Modify archive.c to include the prefix in the path used by
> `--add-virtual-file`

Aligning code and docs is a good idea. Have you considered keeping the code as is and changing the documentation instead, though?

The two options are related in that they both add untracked files, but they necessarily have different arguments:

   --add-file=<file>
   --add-virtual-file=<path>:<content>

You can already specify any path you want with --add-virtual-file. What's the advantage of honoring --prefix as well?

René