Skip to content

README: open with the current release, 4.0.0 as history - #492

Merged
mgrossmann merged 2 commits into
mainfrom
doc-1242-readme-4.5
Oct 31, 2026
Merged

mgrossmann merged 2 commits into
mainfrom
doc-1242-readme-4.5

Conversation

@mgrossmann

Copy link
Copy Markdown
Contributor

Closes #491.

Summary

  • Opening: what HTTPD is, current release 4.5.1, links to the manuals on Read the Docs, the release page and the installation guide.
  • "What's New in 4.0.0" becomes a short "History: 4.0.0" section.
  • Statements that no longer matched 4.5.x are corrected against source and books: the preliminary install guide is replaced by the prerequisites from docs/installation.md (RAKF or APF entry required, UFSD and mvsMF optional, FTPD not needed), LOGIN is gone from the configuration table (retired, parse_keyvalue in src/httpprm.c), AUTH= and the public default are stated, the MOD=LUA example is dropped (the guide shows MOD=REXX), the ecosystem table lists libc370, crypto370, httplua and httprexx instead of crent370.
  • The unverified "h1spec 33/33" claim is not carried over.

Not changed

Books, docs/installation.md, code, version, CHANGELOG.

Test plan

  • Links resolve (Read the Docs project, release v4.5.1, docs/*.md, internals/development.md)
  • Keyword defaults match "The HTTPPRM Keywords"

…history (#491)

The README led with the 4.0.0 release notes and a preliminary install
guide. It now says what HTTPD is, names 4.5.1, points to the manuals and
the release page, and corrects the prerequisites, the retired LOGIN
keyword and the ecosystem table. The 4.0.0 notes stay as a short history.
@mgrossmann mgrossmann added this to the 4.6.0 milestone Oct 31, 2026
@mgrossmann

Copy link
Copy Markdown
Contributor Author

Review: APPROVE

README only; no code, books, version or changelog touched. I re-derived the statements from source and books on the branch:

  • Release 4.5.1: tags v4.5.0 and v4.5.1 exist, the release URL is the one in the PR.
  • Defaults in the configuration table (PORT 8080, MINTASK 3, MAXTASK 9, KEEPALIVE_TIMEOUT 5, KEEPALIVE_MAX 100, DOCROOT /www, SMF NONE) match set_defaults() in src/httpprm.c.
  • LOGIN is retired (src/httpprm.c, comment at the LOGIN branch and at the Auth model cleanup (post-4.0.0): rename HTTPCGI -> route type; retire the global LOGIN bitmask #105 block); LOC= and per-route AUTH= as in the Reference.
  • Prerequisites (SMP 4, RAKF or APF entry, UFSD and mvsMF optional, FTPD not needed) match docs/installation.md section 2.
  • Book numbers ML07-0001 / ML07-0002 match docs/books; all linked files (docs/configuration.md, docs/server-modules.md, docs/installation.md, docs/migration.md, internals/development.md) exist; Read the Docs build for the PR succeeded.
  • Display modules HTTPDSRV, HTTPDM, HTTPDMTT and ABEND0C1 appear in samplib/httpprm0 and the Reference; "not routed by default" matches the commented-out routes there.
  • Consumer names appear only in the module and ecosystem passages, as before; no job numbers, no internal hosts, no AI mention.

Suggestion (not blocking): the "Starting and Stopping" block was left as it was; it is correct (/P HTTPD, D CONFIG, D STATS, HELP exist in src/httpcons.c).

Open on my side before merge: build check still running, and QA acceptance because the issue carries a "Done when".

@mgrossmann

Copy link
Copy Markdown
Contributor Author

Review update: CHANGES REQUESTED

My earlier APPROVE missed two points that QA found; I re-derived both from the branch and they hold.

Must fix

  1. README.md, section "Configuration": "A route without AUTH= is public." is wrong as a general statement. docs/books/ref/ref-route.typ (the AUTH= table, and the rule below it): a line with RES= and without AUTH= gets BASIC; only a route with neither AUTH= nor RES= is public. A reader who has never seen RES= cannot place the sentence. Suggested: "A route with neither AUTH= nor RES= is public."
  2. README.md, section "Installation", prerequisites: the mvsMF bullet names a consumer product outside the module and ecosystem sections. Reword without the product name ("a server module, only if you want the REST API the shipped configuration routes to") and point to "Server Modules".

Everything else I checked stands. Please push both changes as one commit on the same branch.

@sonarqubecloud

Copy link
Copy Markdown

@mgrossmann

Copy link
Copy Markdown
Contributor Author

Review: APPROVE (commit 309ac1b)

Both must-fix points are resolved; the diff against the previously reviewed commit is two lines in README.md, no line-ending change.

  • "A route with neither AUTH= nor RES= is public. A route with RES= and no AUTH= is challenged with BASIC." matches the AUTH= table and the rule below it in docs/books/ref/ref-route.typ.
  • The prerequisites bullet no longer names a consumer product and points to "Server Modules".

Pending before merge: CI on this commit and QA's re-check.

@mgrossmann
mgrossmann merged commit 845237c into main Oct 31, 2026
5 checks passed
@mgrossmann
mgrossmann deleted the doc-1242-readme-4.5 branch October 31, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README opens with 4.0.0 and a preliminary install guide

1 participant