docs: restore the pn_ parameter names in registrar, mid_registrar and… - #4242
Open
denys-i-didww wants to merge 1 commit into
Open
docs: restore the pn_ parameter names in registrar, mid_registrar and…#4242denys-i-didww wants to merge 1 commit into
denys-i-didww wants to merge 1 commit into
Conversation
… usrloc [skip ci]
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.
Summary
Commit e941906 (
docs: fix README.md typos, 5 Aug 2026) replaced every occurrence ofpnwithonin the registrar and mid_registrar documentation. That commit fixed a greatmany real typos across 135 files; in these pages it also rewrote identifiers, and
pnhere is not a typo — it is Push Notification.
Eight module parameters in each of the two modules now carry a name that exists nowhere in
the source tree:
lib/reg/pn.hon_enablepn_enableon_providerspn_providerson_ct_match_paramspn_ct_match_paramson_pnsreg_intervalpn_pnsreg_intervalon_trigger_intervalpn_trigger_intervalon_skip_on_intervalpn_skip_pn_intervalon_refresh_timeoutpn_refresh_timeouton_enable_purrpn_enable_purrThe parameters come from one macro in
lib/reg/pn.h, which is why the same eight areaffected in both modules. A configuration written from the current pages does not start:
OpenSIPS refuses an unknown
modparamwhile parsing, before any module is initialised.What else the substitution reached
pn_process_purr(), documented ason_process_purr();pn_ct_match_params:pn-provider, pn-prid, pn-parambecameon-provider, on-prid, on-param, and;pn-purr=XXXbecame;on-purr=XXX;Notification (ON) support", and "PN-enabled contact" reads "ON-enabled contact";
usrloc, which cites registrar'spn_trigger_interval.on_skip_on_intervalis the clearest fingerprint: both halves ofpn_skip_pn_intervalwere replaced, including the one in the middle of the name.
Reproduced
On the official
opensips/opensips:4.0image, onemodparamper run,opensips -C:All sixteen documented names are refused, eight in each module, with the same message.
All sixteen restored names are accepted.
pn_enableneeds one note: set to1it declares a dependency ontmandevent_routing(lib/reg/pn.c:227-238), so a config withoutevent_routingstops onthat instead — with the module loaded it starts, and so does
pn_enable=0. The sweptname
on_enableis still refused as not found withevent_routingloaded, so the nameis the variable and the dependency is not.
The async function was checked the same way, in a script that calls it:
pn_process_purr()loads,
on_process_purr()fails to parse.Scope
This PR restores
pnonly. Everything else that commit changed in these files is left asit is —
overwride→overridesand the rest are real corrections and are not touched.Verification
After this change every parameter documented in the two modules matches a name registered
in
lib/reg/pn.h— the eight above, checked by name against the macro. Nothing else wasrewritten:
t_on_reply()andt_on_branch()still read as before in the registrarexamples, and no
on_,on-orONtoken that belongs there was touched.Not in this PR
The same commit renamed two more identifiers elsewhere, and they need their own decision
rather than being folded in here:
httpd: the documented callbackhttpd_acces_handler_cbbecamehttpd_access_handler_cb. The typo is real, but it is a C API symbol declared inhttpd_load.h:68and used athttpd.c:240, so the fix belongs in the code, not in thepage describing it.
db_virtual:db_max_consec_retrysbecamedb_max_consec_retries. Same shape — thecode carries the misspelling, and the correct fix is in the code. Happy to send either.
AI assistance disclosure. This report and the change were produced with AI assistance.
Every item was checked against the source before submission:
lib/reg/pn.h:90-97, in a macro shared by bothmodules;
on_*form of any of them appears in any.cor.hfile in the tree —repository-wide grep;
pn_process_purris the async function checked for atlib/reg/pn.c:211and:217;pn-provider,pn-prid,pn-paramare the literals atlib/reg/pn.c:54-56, and thedefault value of the parameter at
lib/reg/pn.c:44;modules, plus the async function, on the official 4.0 image; the commands and their
output are quoted above;
git log -Son each name over the fullhistory, unshallowed for this purpose — rather than assumed from the current state;
135 files that commit touched.