why no mention of "hooks.allownonascii" in any man page?

why no mention of "hooks.allownonascii" in any man page?

[Robert P. J. Day]

  was just perusing the sample hook scripts, and the sample pre-commit
script provided with git does the following check:

# If you want to allow non-ASCII filenames set this variable to true.
allownonascii=$(git config --bool hooks.allownonascii)

  but that config variable (hooks.allownonascii) is not mentioned in
any man page. its entire existence in the git code base consists of:

$ grep -r allownonascii *
templates/hooks--pre-commit.sample:allownonascii=$(git config --bool hooks.allownonascii)
templates/hooks--pre-commit.sample:if [ "$allownonascii" != "true" ] &&
templates/hooks--pre-commit.sample:  git config hooks.allownonascii true

  technically, there's nothing wrong with that, i just thought it was
a bit weird that a sample hook script refers to a config variable that
is not referred to in any way elsewhere.

  should i care?

rday

Re: why no mention of "hooks.allownonascii" in any man page?

[Ævar Arnfjörð Bjarmason]

On Tue, Feb 19 2019, Robert P. J. Day wrote:

>   was just perusing the sample hook scripts, and the sample pre-commit
> script provided with git does the following check:
>
> # If you want to allow non-ASCII filenames set this variable to true.
> allownonascii=$(git config --bool hooks.allownonascii)
>
>   but that config variable (hooks.allownonascii) is not mentioned in
> any man page. its entire existence in the git code base consists of:
>
> $ grep -r allownonascii *
> templates/hooks--pre-commit.sample:allownonascii=$(git config --bool hooks.allownonascii)
> templates/hooks--pre-commit.sample:if [ "$allownonascii" != "true" ] &&
> templates/hooks--pre-commit.sample:  git config hooks.allownonascii true
>
>   technically, there's nothing wrong with that, i just thought it was
> a bit weird that a sample hook script refers to a config variable that
> is not referred to in any way elsewhere.

The hook itself spontaneously introduces it and uses it. There's nothing
magical about config variable, e.g. it could also be "xyz.abc" instead
of "hooks.allownonascii".

But perhaps it should be documented as the functionality of the default
hook in githooks(5), similarly to how we document
hooks.allowunannotated. Patches welcome :)

Re: why no mention of "hooks.allownonascii" in any man page?

[Robert P. J. Day]

[-- Attachment #1: Type: text/plain, Size: 1810 bytes --]

On Tue, 19 Feb 2019, Ævar Arnfjörð Bjarmason wrote:

>
> On Tue, Feb 19 2019, Robert P. J. Day wrote:
>
> >   was just perusing the sample hook scripts, and the sample pre-commit
> > script provided with git does the following check:
> >
> > # If you want to allow non-ASCII filenames set this variable to true.
> > allownonascii=$(git config --bool hooks.allownonascii)
> >
> >   but that config variable (hooks.allownonascii) is not mentioned in
> > any man page. its entire existence in the git code base consists of:
> >
> > $ grep -r allownonascii *
> > templates/hooks--pre-commit.sample:allownonascii=$(git config --bool hooks.allownonascii)
> > templates/hooks--pre-commit.sample:if [ "$allownonascii" != "true" ] &&
> > templates/hooks--pre-commit.sample:  git config hooks.allownonascii true
> >
> >   technically, there's nothing wrong with that, i just thought it was
> > a bit weird that a sample hook script refers to a config variable that
> > is not referred to in any way elsewhere.
>
> The hook itself spontaneously introduces it and uses it. There's
> nothing magical about config variable, e.g. it could also be
> "xyz.abc" instead of "hooks.allownonascii".
>
> But perhaps it should be documented as the functionality of the
> default hook in githooks(5), similarly to how we document
> hooks.allowunannotated. Patches welcome :)

  sure, i'll take care of that.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                  http://crashcourse.ca/dokuwiki

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Re: why no mention of "hooks.allownonascii" in any man page?

[Junio C Hamano]

"Robert P. J. Day" <rpjday@crashcourse.ca> writes:

>> But perhaps it should be documented as the functionality of the
>> default hook in githooks(5), similarly to how we document
>> hooks.allowunannotated. Patches welcome :)
>
>   sure, i'll take care of that.

Sounds like a sensible way forward.  Thanks, both.