Re: [PATCH] git-svn: mention `svn:globalignores` in help+docs

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 13, 2024, 17:36 UTC
Message-ID: <xmqq4j7o5nqn.fsf@gitster.g>
In-Reply-To: <pull.1766.git.git.1723500383989.gitgitgadget@gmail.com>

"Alex Galvin via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 7 quoted lines

> From: Alex Galvin <alex.v.galvin@gmail.com>
>
> Git-SVN was previously taught to use the svn:globalignores attribute
> as well as svn:ignore when creating or showing .gitignore files from
> a Subversion repository. However, the documentation and help message
> still only mentioned svn:ignore. This commit updates Git-SVN's
> documentation and help command to mention the newly supported attribute.

Thanks for tying these loose ends.  Very much appreciated.

Show 6 quoted lines

> @@ -219,7 +219,7 @@ my %cmd = (
>  	                "Set an SVN repository to a git tree-ish",
>  			{ 'stdin' => \$_stdin, %cmt_opts, %fc_opts, } ],
>  	'create-ignore' => [ \&cmd_create_ignore,
> -			     'Create a .gitignore per svn:ignore',
> +			     'Create a .gitignore per directory with svn:ignore and svn:globalignores',

I do not know how likely it is that Subversion gains even more sources of exclusion data in the future, but it makes me wonder if a phrase like "Create a .gitignore file from ignore properties of svn" so that we do not have to muck with the message. Presumably those who do use this feature know which properties Subversion uses to record the ignored paths. On the other hand, if it is not expected to happen very soon, I think the text in this patch is good enough, and we can revisit the issue of help text getting overly long when we do need to add the third one.

The same comment applies to the runtime option help for the other one. I think listing the set of ignore properties we are aware of, iow what you have in this patch, is perfectly appropriate for the documentation.

Thanks.