CodingGuidelines: document a shell that "fails" "VAR=VAL shell_func"
commit728a1962cdaf7df6a1f261dcf3167842cd2db170
authorJunio C Hamano <gitster@pobox.com>
Tue, 23 Jul 2024 00:04:54 +0000 (22 17:04 -0700)
committerJunio C Hamano <gitster@pobox.com>
Tue, 23 Jul 2024 15:28:43 +0000 (23 08:28 -0700)
treee64064ba54556aaa4cf851017c3bb078b87e329a
parentc2b3f2b3cdbf5ad9feb978dd367d77561a1271f7
CodingGuidelines: document a shell that "fails" "VAR=VAL shell_func"

Over the years, we accumulated the community wisdom to avoid the
common "one-short export" construct for shell functions, but seem to
have lost on which exact platform it is known to fail.  Now during
an investigation on a breakage for a recent topic, we found one
example of failing shell.  Let's document that.

This does *not* mean that we can freely start using the construct
once Ubuntu 20.04 is retired.  But it does mean that we cannot use
the construct until Ubuntu 20.04 is fully retired from the machines
that matter.  Moreover, posix explicitly says that the behaviour for
the construct is unspecified.

Helped-by: Kyle Lippincott <spectral@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines