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

[PATCH 0/4] Documentation: improve linting of manpage existence

From
Patrick Steinhardt <ps@pks.im>
Date
Jun 5, 2024, 05:16 UTC
Message-ID
<cover.1717564310.git.ps@pks.im>
Hi,

in [1], Junio noticed that `make check-docs` was failing for a recent patch series of mine that introduces the new git-refs(1) command. Curiously though, while the checks do print errors, the Makefile target itself succeeded and thus did not make the corresponding CI job fail.

This patch series fixes that issue and also refactors the infrastructure such that it fits better into our existing set of linter targets for our documentation. Finally, this series then adds a job to GitLab CI that is equivalent to the job we already have on GitHub Actions.

[1]: <xmqqjzj9czop.fsf@gitster.g>
Patrick
Patrick Steinhardt (4):
  Makefile: extract script to lint missing/extraneous manpages
  Documentation/lint-manpages: bubble up errors
  gitlab-ci: add job to run `make check-docs`
  ci/test-documentation: work around SyntaxWarning in Python 3.12
 .gitlab-ci.yml                 |   9 +++
 Documentation/Makefile         |   4 ++
 Documentation/lint-manpages.sh | 107 +++++++++++++++++++++++++++++++++
 Makefile                       |  36 -----------
 ci/test-documentation.sh       |   1 +
 5 files changed, 121 insertions(+), 36 deletions(-)
 create mode 100755 Documentation/lint-manpages.sh
-- 
2.45.2.409.g7b0defb391.dirty
Next: Patrick Steinhardt
Message 1 of 18 in “Documentation: improve linting of manpage existence”
  1. 0/4 Documentation: improve linting of manpage existencePatrick Steinhardt, Jun 5, 2024
  2. 1/4 Makefile: extract script to lint missing/extraneous manpagesPatrick Steinhardt, Jun 5, 2024
  3. Junio C HamanoJun 5, 2024
  4. Patrick SteinhardtJun 5, 2024
  5. James LiuJun 6, 2024
  6. Junio C HamanoJun 6, 2024
  7. 2/4 Documentation/lint-manpages: bubble up errorsPatrick Steinhardt, Jun 5, 2024
  8. Junio C HamanoJun 5, 2024
  9. 3/4 gitlab-ci: add job to run `make check-docs`Patrick Steinhardt, Jun 5, 2024
  10. 4/4 ci/test-documentation: work around SyntaxWarning in Python 3.12Patrick Steinhardt, Jun 5, 2024
  11. Junio C HamanoJun 5, 2024
  12. 0/4 Documentation: improve linting for manpage existencePatrick Steinhardt, Jun 6, 2024
  13. 1/4 Makefile: extract script to lint missing/extraneous manpagesPatrick Steinhardt, Jun 6, 2024
  14. Junio C HamanoJun 7, 2024
  15. 2/4 Documentation/lint-manpages: bubble up errorsPatrick Steinhardt, Jun 6, 2024
  16. 3/4 gitlab-ci: add job to run `make check-docs`Patrick Steinhardt, Jun 6, 2024
  17. 4/4 ci/test-documentation: work around SyntaxWarning in Python 3.12Patrick Steinhardt, Jun 6, 2024
  18. James LiuJun 7, 2024

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.