On 21/02/2019 12:19, Nguyễn Thái Ngọc Duy wrote:
> Worktree names are based on $(basename $GIT_WORK_TREE). They aren't
> significant until 3a3b9d8cde (refs: new ref types to make per-worktree
> refs visible to all worktrees - 2018-10-21), where worktree name could
> be part of a refname and must follow refname rules.
>
> Update 'worktree add' code to remove special characters to follow
> these rules. The code could replace chars with '-' more than
> necessary, but it keeps the code simple. In the future the user will
> be able to specify the worktree name by themselves if they're not
> happy with this dumb character substitution.
>
> Reported-by: Konstantin Kharlamov <hi-angel@xxxxxxxxx>
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@xxxxxxxxx>
> ---
> builtin/worktree.c | 51 ++++++++++++++++++++++++++++++++++++++++-
> t/t2025-worktree-add.sh | 7 ++++++
> 2 files changed, 57 insertions(+), 1 deletion(-)
>
> diff --git a/builtin/worktree.c b/builtin/worktree.c
> index 3f9907fcc9..53e41db229 100644
> --- a/builtin/worktree.c
> +++ b/builtin/worktree.c
> @@ -262,6 +262,50 @@ static void validate_worktree_add(const char *path, const struct add_opts *opts)
> free_worktrees(worktrees);
> }
>
> +/*
> + * worktree name is part of refname and has to pass
> + * check_refname_component(). Remove unallowed characters to make it
> + * valid.
> + */
> +static void sanitize_worktree_name(struct strbuf *name)
> +{
> + char *orig_name = xstrdup(name->buf);
> + int i;
> +
> + /*
> + * All special chars replaced with dashes. See
> + * check_refname_component() for reference.
> + * Note that .lock is also turned to -lock, removing its
> + * special status.
> + */
> + for (i = 0; i < name->len; i++) {
> + if (strchr(":?[]\\~ \t@{}*/.", name->buf[i]))
> + name->buf[i] = '-';
> + }
> +
> + /* remove consecutive dashes, leading or trailing dashes */
Why? So, '[fred]' will be 'sanitized' to 'fred' (rather than '-fred-'),
which would increase the chance of a 'collision' with the 'fred'
worktree (not very likely, but still). Is that useful? How about
'x86_64-*-gnu' which now becomes 'x86_64-gnu'?
> + for (i = 0; i < name->len; i++) {
> + while (name->buf[i] == '-' &&
> + (i == 0 ||
> + i == name->len - 1 ||
> + (i < name->len - 1 && name->buf[i + 1] == '-')))
> + strbuf_remove(name, i, 1);
> + }
> +
> + /*
> + * a worktree name of only special chars would be reduced to
> + * an empty string
> + */> + if (name->len == 0)
> + strbuf_addstr(name, "worktree");
If you didn't 'collapse' the name above, you could check for
an empty name at the top and wouldn't need this (presumably
an empty name would not be valid).
ATB,
Ramsay Jones
