Re: [PATCH v2 18/27] gitattributes doc: reword discussion of built-in userdiff patterns
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Feb 16, 2021, 23:57 UTC
- Message-ID
- <xmqqa6s3o9a8.fsf@gitster.c.googlers.com>
- In-Reply-To
- <20210215154427.32693-19-avarab@gmail.com>
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
Show 11 quoted lines
> Reword the discussion of the built-in userdiff patterns to make it > more natural to precede it with a discussion about the semantics of > pattern matching, instead of assuming that it follows right after the > "diff.tex.xfuncname" example which now immediately precedes it. This > will make a follow-up commit smaller. > > Helped-by: Eric Sunshine <sunshine@sunshineco.com> > Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> > --- > Documentation/gitattributes.txt | 16 +++++++++++----- > 1 file changed, 11 insertions(+), 5 deletions(-)
Good changes. The current text, which dates back to ae7aa499 (Document custom hunk header selection, 2007-07-08), may have been adequate back when there were only "java" and "tex" built-in patterns but not anymore.
I may (or may not) give the series a second pass to collect independently salvageable bits, and if I did so, this would be one of those that would be gleaned.
Thanks.
Show 26 quoted lines
> diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt > index e84e104f93..62c1147ba9 100644 > --- a/Documentation/gitattributes.txt > +++ b/Documentation/gitattributes.txt > @@ -794,11 +794,17 @@ backslashes; the pattern above picks a line that begins with a > backslash, and zero or more occurrences of `sub` followed by > `section` followed by open brace, to the end of line. > > -There are a few built-in patterns to make this easier, and `tex` > -is one of them, so you do not have to write the above in your > -configuration file (you still need to enable this with the > -attribute mechanism, via `.gitattributes`). The following built in > -patterns are available: > +There are built-in patterns shipped as part of git itself. A more > +advanced version of the `tex` pattern discussed above is one of them. > + > +For built-in patterns, you do not need `diff.<lang>.xfuncname` in your > +configuration file as discussed above, but if present, it will > +override a built-in pattern. > + > +Nevertheless, you need to enable built-in patterns via .gitattributes` > +for the pattern to take effect. > + > +The following built-in patterns are available: > > - `ada` suitable for source code in the Ada language.