[TASK] Align the Makefile with the other documentation manuals - #863
Merged
Merged
Conversation
The Makefiles across the documentation manuals had drifted apart: the strict rendering target was named docs-test in one manual and test-docs in the others, some ran --fail-on-log while their own CI ran --minimal-test, two had lost `make help` to space indentation, and several help descriptions were copy-paste leftovers from unrelated targets. They are being unified on one shared block, so the same command means the same thing in every manual. test-docs ran --fail-on-log while this manual's CI renders with --minimal-test, so the local check did not predict the CI result; it now runs what CI runs. test-cgl called runTests.sh without -n, so `make test` silently rewrote the working tree instead of checking it; the check is now a dry run and `make fix` remains the way to apply the changes. The composerUpdate target becomes install, matching the other manuals, and stays available under its old name. Its help descriptions all read "Regenerate code snippets", which none of them did. Also correct AGENTS.md, which described `make test-docs` as rendering in fail-on-log mode while the Makefile used --minimal-test. Releases: main, 14.3 Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
|
Successfully created backport PR for |
linawolf
added a commit
that referenced
this pull request
Sep 10, 2026
…#864) The Makefiles across the documentation manuals had drifted apart: the strict rendering target was named docs-test in one manual and test-docs in the others, some ran --fail-on-log while their own CI ran --minimal-test, two had lost `make help` to space indentation, and several help descriptions were copy-paste leftovers from unrelated targets. They are being unified on one shared block, so the same command means the same thing in every manual. test-docs ran --fail-on-log while this manual's CI renders with --minimal-test, so the local check did not predict the CI result; it now runs what CI runs. test-cgl called runTests.sh without -n, so `make test` silently rewrote the working tree instead of checking it; the check is now a dry run and `make fix` remains the way to apply the changes. The composerUpdate target becomes install, matching the other manuals, and stays available under its old name. Its help descriptions all read "Regenerate code snippets", which none of them did. Also correct AGENTS.md, which described `make test-docs` as rendering in fail-on-log mode while the Makefile used --minimal-test. Releases: main, 14.3 Assisted-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Lina Wolf Signed-off-by: Lina Wolf Co-authored-by: Lina Wolf <> (cherry picked from commit 684ea19) Signed-off-by: Lina Wolf Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Makefiles across the documentation manuals had drifted apart: the
strict rendering target was named docs-test in one manual and test-docs in
the others, some ran --fail-on-log while their own CI ran --minimal-test,
two had lost
make helpto space indentation, and several helpdescriptions were copy-paste leftovers from unrelated targets. They are
being unified on one shared block, so the same command means the same
thing in every manual.
test-docs ran --fail-on-log while this manual's CI renders with
--minimal-test, so the local check did not predict the CI result; it now
runs what CI runs. test-cgl called runTests.sh without -n, so
make testsilently rewrote the working tree instead of checking it; the check is now
a dry run and
make fixremains the way to apply the changes. ThecomposerUpdate target becomes install, matching the other manuals, and
stays available under its old name. Its help descriptions all read
"Regenerate code snippets", which none of them did.
Also correct AGENTS.md, which described
make test-docsas rendering infail-on-log mode while the Makefile used --minimal-test.
Releases: main, 14.3
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf