[Emc-commit] [LinuxCNC/linuxcnc] 9e240d: docs(build): relocate generated manpages under doc...

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

  Branch: refs/heads/master
  Home:   https://github.com/LinuxCNC/linuxcnc
  Commit: 9e240de73f512a924ca1026132abbd0b9361e79e
      https://github.com/LinuxCNC/linuxcnc/commit/9e240de73f512a924ca1026132abbd0b9361e79e
  Author: Luca Toniolo <107...@us...>
  Date:   2026-06-04 (Thu, 04 Jun 2026)

  Changed paths:
    M docs/.gitignore
    R docs/man/an-old-fixed.tmac
    R docs/man/images/Images_info.adoc
    R docs/man/images/toggle.json
    R docs/man/images/toggle.ps
    R docs/man/images/toggle2nist.json
    R docs/man/images/toggle2nist.ps
    R docs/man/stylesheet.9
    M docs/po4a.cfg
    M docs/src/Submakefile
    M docs/src/gen_complist.py
    M docs/src/hal/tutorial.adoc
    M scripts/rip-environment.in
    M src/Doxyfile
    M src/Makefile
    M src/hal/components/Submakefile
    R src/hal/components/stylesheet.9
    M src/hal/user_comps/Submakefile
    M src/hal/user_comps/pi500_vfd/Submakefile
    M src/hal/user_comps/wj200_vfd/Submakefile
    M src/hal/utils/halcompile.g

  Log Message:
  -----------
  docs(build): relocate generated manpages under docs/build/man/, build translated

Move the generated troff manpage tree out of the source tree into
docs/build/man/.  Layout follows the /usr/share/man hierarchy: English at
docs/build/man/manN (the C/default locale) and translations at
docs/build/man/<lang>/manN.  This differs on purpose from the
build/html/<lang> and build/adoc/<lang> convention, because man(1) resolves
a MANPATH entry by locale and LANG=C only checks <path>/manN; the English
special-casing is documented in the Submakefile header.  docs/man/ is
removed; nothing generated lives in the source tree anymore.

- docs/src/Submakefile: add DOC_MAN; repoint manpage generation, MAN_SRCS,
  MAN_HTML_RULE, gen_complist prereq, MAN_DEPS and clean targets.
- Build translated manpages: po4a emits the [type: man_def] comp manpages
  straight to build/man/<lang>/, and TRANSLATED_TROFF_RULE renders the
  .adoc-sourced manpages from build/adoc/<lang>/man into build/man/<lang>/;
  per-language HTML reuses MAN_HTML_RULE.
- comp/driver/user_comp manpages (src/hal/.../Submakefile) and linuxcnc.1
  now emit to docs/build/man/manN.
- po4a.cfg: point the [type: man_def] entries at build/man/ for both master
  and per-language output (structural paths only; no translatable strings).
- install-man + swish index (src/Makefile), Doxygen MAN_OUTPUT, halcompile
  run-in-place fallback, gen_complist paths, and the run-in-place MANPATH
  (rip-environment) all follow.
- docs/.gitignore: drop the obsolete man/ ignores; build/ already covers them.
- delete the unreferenced legacy groff_www assets rather than carry them into
  the new tree (Bertho confirmed unused): an-old-fixed.tmac, man/images/, and
  both stylesheet.9 copies (docs/man/ and src/hal/components/).  These were the
  old groff -Thtml pipeline (.HEAD CSS injection, wavedrom waveform images),
  obsolete since component manpages render through asciidoctor.
- tutorial.adoc: update the `man -M` example path.

  Commit: a2b3fb4499ebff0375ce2812a4b40fc630bbea12
      https://github.com/LinuxCNC/linuxcnc/commit/a2b3fb4499ebff0375ce2812a4b40fc630bbea12
  Author: Luca Toniolo <107...@us...>
  Date:   2026-06-04 (Thu, 04 Jun 2026)

  Changed paths:
    M docs/src/Submakefile

  Log Message:
  -----------
  docs(build): render the full manpage set in every language

Translated landing pages now list and link the same manpages English
does, rather than only the ~205 that have a po4a translation.  Each
language renders all 455 manpages: translated where a po4a leg provides
it (AsciiDoc_def adoc or man_def troff), English fallback otherwise.  The
per-page completeness is for the topbar banner (separate branch) to show.

- MAN_HTML_TARGETS_<lang> is the full English stem set, not just the
  AsciiDoc_def stems.
- MAN_ENONLY_TROFF_RULE copies the English troff for stems with no po4a
  entry (man3 API reference, a few man1/man9) so they have a per-language
  prerequisite; install ships English man only, so no install impact.
- MAN_HTML_RULE gains committed-src and en-generated adoc fallbacks so
  man_def-only and generated manpages (matrix_kb.9, linuxcnc.1) resolve
  their English adoc per language instead of erroring.
- Per-language index.html appends the English manpage index; with full
  parity every relative man/ href resolves under <lang>/man/.

Clean -j8 htmldocs: 386s -> 465s (+79s) for the extra per-language
renders.

  Commit: 06df292e6bc0b4c5285feebda0b6c47b965dd44f
      https://github.com/LinuxCNC/linuxcnc/commit/06df292e6bc0b4c5285feebda0b6c47b965dd44f
  Author: Luca Toniolo <107...@us...>
  Date:   2026-06-04 (Thu, 04 Jun 2026)

  Changed paths:
    M docs/src/Submakefile

  Log Message:
  -----------
  docs(build): index.incl depends on English man list, not full 9-lang

With every language rendering the full manpage set, MAN_HTML_TARGETS
grew to ~4000 paths; echoing it into objects/var-MAN_HTML_TARGETS made a
single bash argument over Linux's 128 KiB MAX_ARG_STRLEN, so CI htmldocs
failed with 'Argument list too long' (passed locally on shorter paths).
index.incl is built only from MAN_HTML_TARGETS_EN, so depend on that var
instead: ~9x smaller, well under the limit, and it no longer rebuilds
when a translation changes.

  Commit: cd0b1bb13c70ba0102d097d97d9f2c684babaa05
      https://github.com/LinuxCNC/linuxcnc/commit/cd0b1bb13c70ba0102d097d97d9f2c684babaa05
  Author: andypugh <an...@bo...>
  Date:   2026-06-07 (Sun, 07 Jun 2026)

  Changed paths:
    M docs/.gitignore
    R docs/man/an-old-fixed.tmac
    R docs/man/images/Images_info.adoc
    R docs/man/images/toggle.json
    R docs/man/images/toggle.ps
    R docs/man/images/toggle2nist.json
    R docs/man/images/toggle2nist.ps
    R docs/man/stylesheet.9
    M docs/po4a.cfg
    M docs/src/Submakefile
    M docs/src/gen_complist.py
    M docs/src/hal/tutorial.adoc
    M scripts/rip-environment.in
    M src/Doxyfile
    M src/Makefile
    M src/hal/components/Submakefile
    R src/hal/components/stylesheet.9
    M src/hal/user_comps/Submakefile
    M src/hal/user_comps/pi500_vfd/Submakefile
    M src/hal/user_comps/wj200_vfd/Submakefile
    M src/hal/utils/halcompile.g

  Log Message:
  -----------
  Merge pull request #4109 from grandixximo/docs/man-tree-on-build

docs(build): relocate generated manpages under docs/build/man/, build translated

Compare: https://github.com/LinuxCNC/linuxcnc/compare/be7019e916f6...cd0b1bb13c70

To unsubscribe from these emails, change your notification settings at https://github.com/LinuxCNC/linuxcnc/settings/notifications