diff mbox series

[5/7] check-docs: do not bother checking for legacy scripts' documentation

Message ID fb3daa6427595b1df24d3664212a704da171c95e.1555070430.git.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series Assorted Documentation-related fixes | expand

Commit Message

Johannes Schindelin via GitGitGadget April 12, 2019, noon UTC 
From: Johannes Schindelin <johannes.schindelin@gmx.de>

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>
---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Junio C Hamano April 15, 2019, 7:19 a.m. UTC | #1 
"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
writes:

> 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.

Yup.  

This is the "other" loop that goes over the list of ALL_COMMANDS and
makes sure each of them has its own documentation page.

Looking good.

>
> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index a5212c64bf..caa20923a4 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -3074,7 +3074,7 @@ check-docs:: Documentation/GIT-EXCLUDED-PROGRAMS
>  		git-merge-octopus | git-merge-ours | git-merge-recursive | \
>  		git-merge-resolve | git-merge-subtree | \
>  		git-fsck-objects | git-init-db | \
> -		git-remote-* | git-stage | \
> +		git-remote-* | git-stage | git-legacy-* | \
>  		git-?*--?* ) continue ;; \
>  		esac ; \
>  		test -f "Documentation/$$v.txt" || \
diff mbox series

Patch

diff --git a/Makefile b/Makefile
index a5212c64bf..caa20923a4 100644
--- a/Makefile
+++ b/Makefile
@@ -3074,7 +3074,7 @@  check-docs:: Documentation/GIT-EXCLUDED-PROGRAMS
 		git-merge-octopus | git-merge-ours | git-merge-recursive | \
 		git-merge-resolve | git-merge-subtree | \
 		git-fsck-objects | git-init-db | \
-		git-remote-* | git-stage | \
+		git-remote-* | git-stage | git-legacy-* | \
 		git-?*--?* ) continue ;; \
 		esac ; \
 		test -f "Documentation/$$v.txt" || \