threads / discuss / 50539

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

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

## tl;dr

4 messages between Feb 19, 2019 and Feb 19, 2019.

replies: 3people: 3as markdown or json

Robert P. J. Day· Feb 19, 2019, 10:48 UTC · lore
  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
Ævar Arnfjörð Bjarmason· Feb 19, 2019, 11:23 UTC · re: Robert P. J. Day · lore

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

On Tue, Feb 19 2019, Robert P. J. Day wrote:
Show 17 quoted lines
>   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 :)

Robert P. J. Day· Feb 19, 2019, 11:38 UTC · re: Ævar Arnfjörð Bjarmason · lore

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

On Tue, 19 Feb 2019, Ævar Arnfjörð Bjarmason wrote:
Show 28 quoted lines
>
> 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
========================================================================
Junio C Hamano· Feb 19, 2019, 19:41 UTC · re: Robert P. J. Day · lore

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

"Robert P. J. Day" <rpjday@crashcourse.ca> writes:
Show 5 quoted lines
>> 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.

← back to recent threads