From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Junio C Hamano <gitster@pobox.com>
Cc: Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, Eric Sunshine <sunshine@sunshineco.com>,
Jeff King <peff@peff.net>
Subject: Re: [PATCH v2 5/8] docs: exclude documentation for commands that have been excluded
Date: Mon, 29 Apr 2019 08:28:31 -0400 (DST) [thread overview]
Message-ID: <nycvar.QRO.7.76.6.1904290828090.45@tvgsbejvaqbjf.bet> (raw)
In-Reply-To: <xmqqef5yefkg.fsf@gitster-ct.c.googlers.com>
Hi Junio,
On Fri, 19 Apr 2019, Junio C Hamano wrote:
> "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
> writes:
>
> > From: Johannes Schindelin <johannes.schindelin@gmx.de>
> >
> > 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 ;-)
Ciao,
Dscho
next prev parent reply other threads:[~2019-04-29 12:28 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-12 12:00 [PATCH 0/7] Assorted Documentation-related fixes Johannes Schindelin via GitGitGadget
2019-04-12 12:00 ` [PATCH 1/7] remote-testgit: move it into the support directory for t5801 Johannes Schindelin via GitGitGadget
2019-04-15 7:08 ` Junio C Hamano
2019-04-18 11:46 ` Johannes Schindelin
2019-04-12 12:00 ` [PATCH 2/7] help -a: do not list commands that are excluded from the build Johannes Schindelin via GitGitGadget
2019-04-15 7:08 ` Junio C Hamano
2019-04-18 12:06 ` Johannes Schindelin
2019-04-12 12:00 ` [PATCH 3/7] check-docs: do not pretend that commands are listed which are excluded Johannes Schindelin via GitGitGadget
2019-04-15 7:18 ` Junio C Hamano
2019-04-18 12:41 ` Johannes Schindelin
2019-04-12 12:00 ` [PATCH 4/7] docs: exclude documentation for commands that have been excluded Johannes Schindelin via GitGitGadget
2019-04-12 18:46 ` Eric Sunshine
2019-04-15 3:09 ` Junio C Hamano
2019-04-15 4:16 ` Eric Sunshine
2019-04-15 4:18 ` Eric Sunshine
2019-04-18 13:08 ` Johannes Schindelin
2019-04-15 14:50 ` Jeff King
2019-04-16 4:12 ` Junio C Hamano
2019-04-18 13:06 ` Johannes Schindelin
2019-04-18 16:01 ` Jeff King
2019-04-12 12:00 ` [PATCH 5/7] check-docs: do not bother checking for legacy scripts' documentation Johannes Schindelin via GitGitGadget
2019-04-15 7:19 ` Junio C Hamano
2019-04-12 12:00 ` [PATCH 6/7] test-tool: handle the `-C <directory>` option just like `git` Johannes Schindelin via GitGitGadget
2019-04-12 12:00 ` [PATCH 7/7] Turn `git serve` into a test helper Johannes Schindelin via GitGitGadget
2019-04-15 14:03 ` Junio C Hamano
2019-04-17 3:46 ` Jeff King
2019-04-17 5:40 ` Junio C Hamano
2019-04-17 18:22 ` Josh Steadmon
2019-04-18 1:58 ` Junio C Hamano
2019-04-18 12:17 ` Johannes Schindelin
2019-04-18 13:16 ` [PATCH v2 0/8] Assorted Documentation-related fixes Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 1/8] remote-testgit: move it into the support directory for t5801 Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 2/8] Makefile: drop the NO_INSTALL variable Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 3/8] help -a: do not list commands that are excluded from the build Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 4/8] check-docs: allow command-list.txt to contain excluded commands Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 5/8] docs: exclude documentation for commands that have been excluded Johannes Schindelin via GitGitGadget
2019-04-19 5:20 ` Junio C Hamano
2019-04-29 12:28 ` Johannes Schindelin [this message]
2019-04-18 13:16 ` [PATCH v2 6/8] check-docs: do not bother checking for legacy scripts' documentation Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 7/8] test-tool: handle the `-C <directory>` option just like `git` Johannes Schindelin via GitGitGadget
2019-04-18 13:16 ` [PATCH v2 8/8] Turn `git serve` into a test helper Johannes Schindelin via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=nycvar.QRO.7.76.6.1904290828090.45@tvgsbejvaqbjf.bet \
--to=johannes.schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).