git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 4/7] docs: exclude documentation for commands that have been excluded

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Apr 18, 2019, 13:06 UTC
Message-ID
<nycvar.QRO.7.76.6.1904181505520.46@tvgsbejvaqbjf.bet>
In-Reply-To
<20190415145042.GA27540@sigill.intra.peff.net>
Hi Peff,
On Mon, 15 Apr 2019, Jeff King wrote:
Show 37 quoted lines
> On Mon, Apr 15, 2019 at 12:16:51AM -0400, Eric Sunshine wrote:
>
> > On Sun, Apr 14, 2019 at 11:10 PM Junio C Hamano <gitster@pobox.com> wrote:
> > > Eric Sunshine <sunshine@sunshineco.com> writes:
> > > >> +Documentation/GIT-EXCLUDED-PROGRAMS: Makefile config.mak.uname
> > > >> +       $(QUIET_GEN)echo "EXCLUDED_PROGRAMS := $(EXCLUDED_PROGRAMS)" >$@
> > > >
> > > > Should this rule also have a dependency upon "config.mak.autogen"?
> > >
> > > That is probably a good point.
> > >
> > > > Perhaps like this:
> > > >
> > > > Documentation/GIT-EXCLUDED-PROGRAMS: Makefile $(wildcard config.mak*)
> > >
> > > I'd rather not let changes to "config.mak-", which I keep in my
> > > working tree (untracked and disabled copy of config.mak, that can be
> > > readily activated by renaming), be part of dependency rules.
> > >
> > > If we know 'autogen' is the only dependency that optionally can
> > > exist, then depending explicitly on $(wildcard config.mak.autogen)
> > > would be a better alternative.
> >
> > When composing that email, I originally wrote $(wildcard
> > config.mak.autogen) as the suggestion but changed it to the looser
> > $(wildcard config.mak*) when I realized that the developer's own
> > config.mak probably ought to be a dependency, as well. Taking your
> > objection into consideration, we could mention both explicitly:
> >
> >     Documentation/GIT-EXCLUDED-PROGRAMS: Makefile \
> >         $(wildcard config.mak) $(wildcard config.mak.autogen)
>
> What about command-line options that influence the outcome? It sounds
> like this is the same problem we have in lots of other places (like say,
> compiler flags being updated), that we solve by generating the proposed
> file output unconditionally and comparing it to what's on disk.  E.g.,
> see the way GIT-CFLAGS or GIT-BUILD-OPTIONS is generated.
*Sigh*

I really did not want to do that because I thought it would be tedious and more complicated and result in a longer patch.

Well, don't you know. The patch is actually *a lot* shorter now. So much so that range-diff thinks it is a different commit ;-)

Thanks for the reality check/prod, Dscho

Previous: Junio C HamanoNext: Jeff King
Message 16 of 41 in “Assorted Documentation-related fixes”
  1. 0/7 Assorted Documentation-related fixesJohannes Schindelin via GitGitGadget, Apr 12, 2019
  2. 1/7 remote-testgit: move it into the support directory for t5801Johannes Schindelin via GitGitGadget, Apr 12, 2019
  3. Junio C HamanoApr 15, 2019
  4. Johannes SchindelinApr 18, 2019
  5. 2/7 help -a: do not list commands that are excluded from the buildJohannes Schindelin via GitGitGadget, Apr 12, 2019
  6. Junio C HamanoApr 15, 2019
  7. Johannes SchindelinApr 18, 2019
  8. 4/7 docs: exclude documentation for commands that have been excludedJohannes Schindelin via GitGitGadget, Apr 12, 2019
  9. Eric SunshineApr 12, 2019
  10. Junio C HamanoApr 15, 2019
  11. Eric SunshineApr 15, 2019
  12. Eric SunshineApr 15, 2019
  13. Johannes SchindelinApr 18, 2019
  14. Jeff KingApr 15, 2019
  15. Junio C HamanoApr 16, 2019
  16. Johannes SchindelinApr 18, 2019
  17. Jeff KingApr 18, 2019
  18. 3/7 check-docs: do not pretend that commands are listed which are excludedJohannes Schindelin via GitGitGadget, Apr 12, 2019
  19. Junio C HamanoApr 15, 2019
  20. Johannes SchindelinApr 18, 2019
  21. 7/7 Turn `git serve` into a test helperJohannes Schindelin via GitGitGadget, Apr 12, 2019
  22. Junio C HamanoApr 15, 2019
  23. Jeff KingApr 17, 2019
  24. Junio C HamanoApr 17, 2019
  25. Josh SteadmonApr 17, 2019
  26. Junio C HamanoApr 18, 2019
  27. Johannes SchindelinApr 18, 2019
  28. 6/7 test-tool: handle the `-C <directory>` option just like `git`Johannes Schindelin via GitGitGadget, Apr 12, 2019
  29. 5/7 check-docs: do not bother checking for legacy scripts' documentationJohannes Schindelin via GitGitGadget, Apr 12, 2019
  30. Junio C HamanoApr 15, 2019
  31. 0/8 Assorted Documentation-related fixesJohannes Schindelin via GitGitGadget, Apr 18, 2019
  32. 1/8 remote-testgit: move it into the support directory for t5801Johannes Schindelin via GitGitGadget, Apr 18, 2019
  33. 2/8 Makefile: drop the NO_INSTALL variableJohannes Schindelin via GitGitGadget, Apr 18, 2019
  34. 3/8 help -a: do not list commands that are excluded from the buildJohannes Schindelin via GitGitGadget, Apr 18, 2019
  35. 4/8 check-docs: allow command-list.txt to contain excluded commandsJohannes Schindelin via GitGitGadget, Apr 18, 2019
  36. 5/8 docs: exclude documentation for commands that have been excludedJohannes Schindelin via GitGitGadget, Apr 18, 2019
  37. Junio C HamanoApr 19, 2019
  38. Johannes SchindelinApr 29, 2019
  39. 6/8 check-docs: do not bother checking for legacy scripts' documentationJohannes Schindelin via GitGitGadget, Apr 18, 2019
  40. 7/8 test-tool: handle the `-C <directory>` option just like `git`Johannes Schindelin via GitGitGadget, Apr 18, 2019
  41. 8/8 Turn `git serve` into a test helperJohannes Schindelin via GitGitGadget, Apr 18, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.