Documentation overhaul: markdown ports verified against the source, P10 S2S reference - #108
Open
MrIron-no wants to merge 16 commits into
Open
Documentation overhaul: markdown ports verified against the source, P10 S2S reference#108MrIron-no wants to merge 16 commits into
MrIron-no wants to merge 16 commits into
Conversation
Derived from the source in ircd/ and include/. Covers wire format, numerics, link establishment, net burst, users, channels, messaging, network policy, extension queries, message tags and conflict resolution, with worked wire examples verified against the code.
The markdown conversion (cherry-picked from release) was based on a July snapshot; main's plaintext readme.features had since gained CLIENT_TAG_FLOOD, TRUST_USERNAME and the expanded NETWORK_FEATURES text. Carry those into readme.features.md so nothing is lost by deleting the plaintext file.
snomask.md is verified against the current SNO_ list in include/client.h (unchanged since the 1997 document). p10.html is superseded by the new p10.md reference.
New server messages documented: Z (TLS certificate fingerprint), A (account applied during registration, e.g. SASL), c/e (CAP negotiation start/end blocking registration). R now documents the account[:id[:flags]] stamp. The u compatibility note reflects that an untrusted username is sent with its ~/^ prefix rather than omitted. Added the WebIRC/Cloudflare/WebSocket introduction-deferral note and the iauth: XQUERY routing detail.
The old file was also stale: the second PING parameter is the target server name, not its numeric.
readme.log.md adds the AUTH snomask to the mask-name list (present in ircd_log.c but missing from the old doc); the subsystem and level tables are otherwise verified unchanged. readme.gline.md adds a verified mask-forms section (user@host, user@ip/cidr, $Rrealname, BADCHAN) and cross-references p10.md 10.1. The .cvsignore files are CVS-era artifacts with no effect under git.
Corrections: the S2S +/- prefix is optional (a bare name is treated as inactive), the lastmod resend is suppressed during bursts, and the oper section now documents CONFIG_OPERCMDS, the JUPE/LOCAL_JUPE privileges per target form, and that expiration/reason are ignored for an existing jupe. Documents the missing privilege check on the implicit-local form as-is.
Corrections from the 1999 text: the default match set is nuhs (info text is no longer matched by default); the a.b.c.d/e.f.g.h netmask form is gone and /32 plus IPv6 CIDR are valid; the x flag requires the whox privilege and see_chan only works together with x; the oplevel field shows n/a for non-ops (levels visible only to opers and chanops); the 354 flags include < for join-delayed members; and the HIS_WHO_* features censor server name, idle and hopcount for non-opers. Hidden-host matching rules documented.
Adds the routing prefixes now in live use (iauth:, sasl:, spam:) with cross-references to p10.md, readme.sasl.md and readme.sline.md, and notes that XQ/XR never carry an IRCv3 @time tag. Handler behavior verified unchanged against m_xquery.c/m_xreply.c.
crules updated to the CRULE block syntax (the D:/d: line format is a historical note), the second example's direct() typo fixed to directcon(), the removed chkconf tool no longer referenced, and the stats letters verified against s_stats.c. configure.ac now points at readme.chroot's new location.
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.
Documentation overhaul: every plaintext readme in doc/ is now either ported to Markdown (verified against the current source) or archived in doc/history/.
New reference
Markdown ports, corrected against the code
Z(TLS fingerprint),A(account during registration),c/e(CAP negotiation) server messages, theRaccount[:id[:flags]]stamp, the changeduuntrusted-username semantics, and the WebIRC/Cloudflare/WebSocket introduction deferral.nuhs(notnuhsr), CIDR-only IP masks (the dotted-netmask form is gone, /32 and IPv6 now valid),xrequires thewhoxprivilege, oplevel showsn/afor non-ops,<flag for join-delayed members, HIS_WHO_* censorship, hidden-host matching rules.+/-prefix is actually optional, burst suppression of lastmod resends, CONFIG_OPERCMDS gate and per-target privileges. Documents the missing PRIV_LOCAL_JUPE check on the implicit-local form (filed upstream as mo_jupe: implicit-local JUPE form bypasses the PRIV_LOCAL_JUPE check #106).directcon()typo fixed, chkconf reference removed.iauth:/sasl:/spam:routing prefixes now in live use.Removed or archived
All live references (example.conf, configure.ac, RELEASE.NOTES, source comments) updated to the new file names; ChangeLog mentions left untouched as history.