Repository navigation
docs: carry the 4.5.1 book and guide text over to main - #486
Merged
Merged
Conversation
The documentation for 4.5.1 (httpd#468, #471, #478, #482, #483) exists only on release-4.5.x. Take docs/installation.md, the book sources and the console captures from there, so that main names THTP451 in the removal job of section 12 and carries the install, upgrade and removal chapters, the start-test text (RAKF0004, HTTPD042W) and the re-recorded captures of 4.5.1. The source of main and of release-4.5.x differs only in mbt.toml and in the MVS tests, so no text describes behaviour that main no longer has.
|
mgrossmann
commented
Oct 31, 2026
mgrossmann
left a comment
mgrossmann
left a comment
Contributor
Author
There was a problem hiding this comment.
Review of #486 (closes #485)
Verdict: APPROVE (documentation only; acceptance by QA still open because #485 has a "Done when")
What I re-derived from the branches
git diff origin/main origin/release-4.5.x -- src includeis empty, so the start test (RAKF0004forHTTPPRB,HTTPD042W) and the identity check are in the code ofmainalready. The text taken over describes behaviourmainhas.git diff origin/doc-485-carry-4.5.1-texts origin/release-4.5.x -- docsis empty: the PR is exactly therelease-4.5.xdocumentation, nothing added, nothing left out.- The PR changes only files under
docs/(68 files); no code, no submodule, nombt.toml. - Text that
mainhad andrelease-4.5.xdid not (#479, the section on a server that accepts any user ID inug-security,ug-trouble,apx-messages,ref-dm,ref-stc) is in files this PR does not touch, so it is kept. The only lines of #479 that are replaced are console captures that said4.6.0-DEVand one table cell inug-install.typthat said the line was "not in the capture"; both are superseded by the re-recorded 4.5.1 captures. THTP451is in the removal job of section 12 ofdocs/installation.md(37 occurrences in that file) and inug-remove.typ,ug-install.typ,ug-upgrade.typ.- CI is green on the final commit f1faa86: build, manuals (typst), SonarCloud gate, Read the Docs.
- No internal host names, addresses, paths or tool names in the added lines; commit message in English; milestone 4.6.0.
Must fix
None.
Suggestion (not for this PR)
As the description says, main still derives THTP460 with DELETE(THTP450). The upgrade chapter now says correctly that a package must delete the FMID the installed system carries. A 4.6.0 package over a 4.5.1 system would therefore not own the modules. That belongs to the 4.6.0 release preparation (project file), not to the books; please make sure it is on the 4.6.0 checklist.
Sure about: the carry-over being complete and exact (checked by diff). Not checked by me: the content of the re-recorded captures themselves; that is QA's acceptance.
APPROVE
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
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.
Closes #485.
What
Takes
docs/installation.md, the book sources underdocs/booksand the console captures fromrelease-4.5.x(the state after #470, #472, #480 and #484, issues #468, #471, #478, #482, #483). 68 files, all underdocs/; no code, no submodule change.On
mainthis brings:THTP451in the removal job of section 12 ofdocs/installation.mdand in the chapter on removal (the 49-statement job, its measured figures, the tombstoneTHTP450)RAKF0004forHTTPPRB,HTTPD042W, in the guide, the upgrade notes, troubleshooting and the message referenceWhy this is safe for 4.6.0
git diff origin/main origin/release-4.5.x -- src includeis empty: the identity check (#464) and the start test are onmainalready. The two branches differ only inmbt.toml(version, FMID) and in the MVS tests. So nothing taken over describes behaviour thatmainno longer has. Of the textmainalready had from #479, every changed line is contained in therelease-4.5.xversion; nothing is lost.As before, the book on
maindescribes the latest release (4.5.1); the 4.6.0 release step rewrites the edition notice, FMID and file names.Checked
typst compile --root . --creation-timestamp 0forml07-0001.typandml07-0002.typ: rc 0, noerror:sh docs/books/web/build.sh: rc 0HTTPD042WandRAKF0004/HTTPPRBagainstinclude/httpdmsg.h,src/httpd.c,src/httppc.cNot in this PR
mbt.tomlandCLAUDE.mdonmainstill deriveTHTP460deletingTHTP450(4.6.0-dev). A 4.6.0 package over a 4.5.1 system would not own the modules (see the table of releases in the upgrade chapter). That is a change to the project file, not to the books; noted for the release.