Subject: Re: [PATCH v3 2/4] quote: add quote_path() flag to ignore config

From: Phillip Wood <[email-masked]>
Date: Sun, 2 Feb 2025 10:52:41 +0000

Hi Justin

On 01/02/2025 20:16, Justin Tobler wrote:
> The `quote_path()` function invokes `quote_c_style_counted()` to handle
> quoting. This means the output `quote_path()` is ultimately affected by
> `core.quotePath` configuration. In a subsequent commit, `quote_path()`
> will be used in a scenario where the output should remain consistent
> regardless of the current configuration.
> 
> Introduce the `QUOTE_PATH_IGNORE_CONFIG` flag for `quote_path()`which
> when set instructs the underlying `quote_c_style_counted()` to also
> ignore the `core.quotePath` configuration when executed.

I'm confused as to why this is necessary. All of our existing plumbing 
commands that print paths respect core.quotePath so why is rev-list 
different? The config setting only affects the representation used for 
bytes 0x80 and above, control characters, backslash and double-quote are 
always quoted.

Best Wishes

Phillip

> Signed-off-by: Justin Tobler <[email-masked]>
> ---
>   quote.c | 13 ++++++++++---
>   quote.h |  3 ++-
>   2 files changed, 12 insertions(+), 4 deletions(-)
> 
> diff --git a/quote.c b/quote.c
> index d129c1de70..baec34ca94 100644
> --- a/quote.c
> +++ b/quote.c
> @@ -370,10 +370,18 @@ char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigne
>   {
>   	struct strbuf sb = STRBUF_INIT;
>   	const char *rel = relative_path(in, prefix, &sb);
> -	int force_dq = ((flags & QUOTE_PATH_QUOTE_SP) && strchr(rel, ' '));
> +	unsigned cquote_flags = 0;
> +	int force_dq = 0;
>   
>   	strbuf_reset(out);
>   
> +	if ((flags & QUOTE_PATH_QUOTE_SP) && strchr(rel, ' ')) {
> +		force_dq = 1;
> +		cquote_flags &= CQUOTE_NODQ;
> +	}
> +	if (flags & QUOTE_PATH_IGNORE_CONFIG)
> +		cquote_flags &= CQUOTE_IGNORE_CONFIG;
> +
>   	/*
>   	 * If the caller wants us to enclose the output in a dq-pair
>   	 * whether quote_c_style_counted() needs to, we do it ourselves
> @@ -381,8 +389,7 @@ char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigne
>   	 */
>   	if (force_dq)
>   		strbuf_addch(out, '"');
> -	quote_c_style_counted(rel, strlen(rel), out, NULL,
> -			      force_dq ? CQUOTE_NODQ : 0);
> +	quote_c_style_counted(rel, strlen(rel), out, NULL, cquote_flags);
>   	if (force_dq)
>   		strbuf_addch(out, '"');
>   	strbuf_release(&sb);
> diff --git a/quote.h b/quote.h
> index 2a793fbef6..84903951ef 100644
> --- a/quote.h
> +++ b/quote.h
> @@ -94,7 +94,8 @@ void write_name_quoted_relative(const char *name, const char *prefix,
>   
>   /* quote path as relative to the given prefix */
>   char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigned flags);
> -#define QUOTE_PATH_QUOTE_SP 01
> +#define QUOTE_PATH_QUOTE_SP	 (1u << 0)
> +#define QUOTE_PATH_IGNORE_CONFIG (1u << 1)
>   
>   /* quoting as a string literal for other languages */
>   void perl_quote_buf(struct strbuf *sb, const char *src);