[OpenSIPS-Devel] [OpenSIPS/opensips] c46dc8: compression: fix the documented parameter name and...

[Bogdan Andrei IANCU]

  Branch: refs/heads/master
  Home:   https://github.com/OpenSIPS/opensips
  Commit: c46dc8ea99897b2fa202b4297c75354aef7b2435
      https://github.com/OpenSIPS/opensips/commit/c46dc8ea99897b2fa202b4297c75354aef7b2435
  Author: Denys Ivonenko <denys.i at didww.com>
  Date:   2026-09-02 (Wed, 02 Sep 2026)

  Changed paths:
    M modules/compression/README.md

  Log Message:
  -----------
  compression: fix the documented parameter name and example [skip ci]

The Exported Parameters section documented the module's C variable name
rather than the parameter it registers, and its only example carried two
further errors.  Each of the three is independently fatal.

* The parameter is "compression_level" (compression.c:158).  "mc_level" is
  the static int it writes to (compression.c:119).
* The example names a module "mc"; the module's name is "compression"
  (compression.c:187).  "mc" is the prefix its exported functions carry -
  mc_compact, mc_compress, mc_decompress.
* The example passes the value as a string.  The parameter is INT_PARAM,
  and set_mod_param_regex() matches the type by mask, so a string value
  never reaches it.

Checked by running opensips -C against each spelling.  The section as
written yields "no module matching mc found" and a parse error; the
corrected line yields "config file ok".  No functional change.


  Commit: 55f63f9927091281ee5cfc3b3cbd381664a6b52f
      https://github.com/OpenSIPS/opensips/commit/55f63f9927091281ee5cfc3b3cbd381664a6b52f
  Author: Bogdan Andrei IANCU <bogdan at opensips.org>
  Date:   2026-09-03 (Thu, 03 Sep 2026)

  Changed paths:
    M modules/compression/README.md

  Log Message:
  -----------
  Merge pull request #4235 from denys-i-didww/docs/fix-compression-parameter-name

compression: fix the documented parameter name and example


Compare: https://github.com/OpenSIPS/opensips/compare/f5f31387b277...55f63f992709

To unsubscribe from these emails, change your notification settings at https://github.com/OpenSIPS/opensips/settings/notifications