Re: [PATCH v2 5/8] docs: exclude documentation for commands that have been excluded

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



"Johannes Schindelin via GitGitGadget" <gitgitgadget@xxxxxxxxx>
writes:

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




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux