]> git.ipfire.org Git - thirdparty/git.git/commit - Makefile
check-docs: do not bother checking for legacy scripts' documentation
authorJohannes Schindelin <johannes.schindelin@gmx.de>
Thu, 18 Apr 2019 13:16:46 +0000 (06:16 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 19 Apr 2019 05:03:24 +0000 (14:03 +0900)
commit31cf4a6ba96c97867451bf6aeca4ea1659c69dcf
treea8f414322888975febfe320c3a2f749502498738
parentfaa7a096d87f188cb8bb2cc1c21f80c91817ce64
check-docs: do not bother checking for legacy scripts' documentation

In the recent years, there has been a big push to convert more and more
of Git's commands that are implemented as scripts to built-ins written
in pure, portable C, for robustness, speed and portability.

One strategy that served us well is to convert those scripts
incrementally, starting by renaming the scripts to
`git-legacy-<command>`, then introducing a built-in that does nothing
else at first than checking the config setting `<command>.useBuiltin`
(which defaults to `false` at the outset) and handing off to the legacy
script if so asked.

Obviously, those `git-legacy-<command>` commands share the documentation
with the built-in `git-<command>`, and are not intended to be called
directly anyway. So let's not try to ensure that they are documented
separately from their built-in versions.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Makefile