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

Re: [PATCH] Allow generating a non-default set of documentation

From
Jeff King <peff@peff.net>
Date
Oct 7, 2012, 23:07 UTC
Message-ID
<20121007230703.GC3490@sigill.intra.peff.net>
In-Reply-To
<7vwqz1oqi4.fsf@alter.siamese.dyndns.org>
On Sun, Oct 07, 2012 at 03:40:19PM -0700, Junio C Hamano wrote:
Show 16 quoted lines
> Jeff King <peff@peff.net> writes:
> 
> > On Sun, Oct 07, 2012 at 01:39:32PM -0700, Junio C Hamano wrote:
> > ...
> >> but it is not so far-fetched to imagine that Windows users may want to
> >> omit manpages with
> >> 
> >>     $ DEFAULT_DOC_TARGET=html make doc
> >
> > That use case makes a lot more sense to me (or more likely setting it in
> > config.mak).
> 
> I actually had "ifeq ($(uname_S),Windows)" at the top-level in mind,
> not config.mak.  I think that is far more important use case than
> going down to Documentation yourself and run make there (which is
> not a workflow I deeply care about in the first place).

Hmm. Unfortunately that does not work from within Documentation, because Documentation/Makefile never gets to see our default-system tweaks (it sees only config.mak).

I know it is a case you do not care about (and nor do I; if I use this at all, it would be to limit my build by setting the variable in my config.mak), but it highlights a subtle issue. The subdir Makefiles receive their config from config.mak.autogen and config.mak, but never get to see any of the default tweaks we do based on $(uname). Which the contents of config.mak could very well depend on, if somebody were trying to be very clever.

Would it make sense to pull all of our platform-specific tweaks out into a config.mak.platform (right before config.mak.autogen)? That would be less surprising for cases like this, and I think it would make the Makefile a lot more readable.

-Peff
Previous: Junio C HamanoNext: Jeff King
Message 7 of 12 in “Allow generating a non-default set of documentation”
  1. Allow generating a non-default set of documentationJunio C Hamano, Oct 7, 2012
  2. Jeff KingOct 7, 2012
  3. Junio C HamanoOct 7, 2012
  4. Junio C HamanoOct 7, 2012
  5. Jeff KingOct 7, 2012
  6. Junio C HamanoOct 7, 2012
  7. Jeff KingOct 7, 2012
  8. Jeff KingOct 7, 2012
  9. Junio C HamanoOct 7, 2012
  10. Jeff KingOct 7, 2012
  11. Junio C HamanoOct 7, 2012
  12. Junio C HamanoOct 8, 2012

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.