Re: [PATCH v2 5/8] docs: exclude documentation for commands that have been excluded
- Date: Mon, 29 Apr 2019 08:28:31 -0400 (DST)
- From: Johannes Schindelin <Johannes.Schindelin@xxxxxx>
- Subject: Re: [PATCH v2 5/8] docs: exclude documentation for commands that have been excluded
On Fri, 19 Apr 2019, Junio C Hamano wrote:
> "Johannes Schindelin via GitGitGadget" <gitgitgadget@xxxxxxxxx>
> > From: Johannes Schindelin <johannes.schindelin@xxxxxx>
> > When building with certain build options, some commands are excluded
> > from the build. For example, `git-credential-cache` is skipped when
> > building with `NO_UNIX_SOCKETS`.
> > Let's not build or package documentation for those excluded commands.
> > This issue was pointed out rightfully when running `make check-docs` on
> > Windows, where we do not yet have Unix sockets, and therefore the
> > `credential-cache` command is excluded (yet its documentation was built
> > and shipped).
> > Note: building the documentation via `make -C Documentation` leaves the
> > build system with no way to determine which commands have been
> > excluded. If called thusly, we gracefully fail to exclude their
> > documentation. Only when building the documentation via the top-level
> > Makefile will it get excluded properly, or after building
> > `Documentation/GIT-EXCLUDED-PROGRAMS` manually.
> I certainly know where you come from, but I am on the fence. Being
> able to omit documentation, without thinking, for what you do not
> ship is surely handy, but at the same time, being able to format
> everything you have the necessary material for is also valuable.
I guess you need a maintainer's mode ;-)