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

Re: [PATCH 8/8] doc: join xml and man rules

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
May 13, 2021, 11:02 UTC
Message-ID
<CAN0heSrWu462h9Ch5K-aMHUgjB-BGqRp9YpWa=vPi_V+MiUwBg@mail.gmail.com>
In-Reply-To
<20210512222803.508446-9-felipe.contreras@gmail.com>

On Thu, 13 May 2021 at 00:28, Felipe Contreras <felipe.contreras@gmail.com> wrote:

>
> Will be useful later with asciidoctor that can do both at the same time.
Show 8 quoted lines
> -%.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl)
> -       $(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
> -
> -%.xml : %.txt $(ASCIIDOC_DEPS)
> -       $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $@ $<
> +%.1 %.5 %.7 : %.txt $(ASCIIDOC_DEPS) manpage-base-url.xsl $(wildcard manpage*.xsl)
> +       $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $*.xml $< && \
> +       $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $*.xml

It does mean that if manpage-base-url.xsl changes, we'll regenerate all the xml files. Before this change, we would just rerun the xmlto step.

Also, this will break `make info`. It will either find xml files that "happen" to be there, e.g., because you just built the manpages (or maybe you did so several weeks ago), or it won't find them and error out.

(If you're wondering if anyone is actually using `make info`, there's some discussion at [1]. I don't think anyone would be too sad to see it go. Once `make info` is the only reason we need to generate the xml files, I think it's a given we should try to drop that stuff.)

I think we should keep the separate xml targets as long as "asciidoctor without xmlto" isn't the only way we support building the manpages. If the only benefit here is "later", I think we should do this patch later. I could also imagine that the xml target will just go away once all the "old" ways of building the manpages are gone and `make info` is gone, i.e., when we simply don't need any of these generated xml files.

[1] https://lore.kernel.org/git/20200402004533.GA6369@camp.crustytoothpaste.net/
Martin
Previous: Felipe ContrerasNext: Felipe Contreras
Message 15 of 19 in “doc: asciidoc cleanups”
  1. 0/8 doc: asciidoc cleanupsFelipe Contreras, May 12, 2021
  2. 3/8 doc: disable asciidoc-helper for asciidoctorFelipe Contreras, May 12, 2021
  3. 2/8 doc: add an asciidoc helperFelipe Contreras, May 12, 2021
  4. Ævar Arnfjörð BjarmasonMay 13, 2021
  5. Felipe ContrerasMay 13, 2021
  6. Junio C HamanoMay 13, 2021
  7. 1/8 doc: standardize asciidoc callsFelipe Contreras, May 12, 2021
  8. 4/8 doc: simplify the handling of interruptionsFelipe Contreras, May 12, 2021
  9. Junio C HamanoMay 13, 2021
  10. Felipe ContrerasMay 13, 2021
  11. 5/8 doc: remove redundant rmFelipe Contreras, May 12, 2021
  12. Ævar Arnfjörð BjarmasonMay 13, 2021
  13. Felipe ContrerasMay 13, 2021
  14. 8/8 doc: join xml and man rulesFelipe Contreras, May 12, 2021
  15. Martin ÅgrenMay 13, 2021
  16. Felipe ContrerasMay 13, 2021
  17. 7/8 doc: improve asciidoc dependenciesFelipe Contreras, May 12, 2021
  18. Martin ÅgrenMay 13, 2021
  19. 6/8 doc: refactor common dependenciesFelipe Contreras, May 12, 2021

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.