Skip to content

Commit

Permalink
Update docs for v4.0.0rc2.
Browse files Browse the repository at this point in the history
  • Loading branch information
SadieCat committed Jun 13, 2024
1 parent 9ae2dde commit 8df0aab
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/4/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ title: v4 Breaking Changes

- OpenSSL 1.1.1+ is now required by the ssl_openssl module.

- PCRE2 is now required by the regex_pcre module. Most regular expressions should be compatible but if not you can use `./modulemanager install m_regex_oldpcre` to install the a module that uses the PCRE1 library.

- Perl 5.26+ is now required by `./configure` and all of the included Perl tools.

- Windows 10 build 17061 is now the minimum supported version of Windows.
Expand All @@ -44,6 +42,8 @@ title: v4 Breaking Changes

- The nationalchars module has been removed. In order to upgrade you should switch to the codepage module instead.

- The regex_pcre module has been moved to inspircd-contrib. In order to upgrade either migrate remove this module from your configuration, run `./modulemanager install m_regex_pcre` to install it, or migrate to [the regex_pcre2 module](/4/modules/regex_pcre2).

- The regex_tre module has been moved to inspircd-contrib. In order to upgrade either remove this module from your configuration or run `./modulemanager install m_regex_tre` to install it.

- The ssl_mbedtls module has been moved to inspircd-contrib. In order to upgrade either remove this module from your configuration or run `./modulemanager install m_ssl_mbedtls` to install it.
Expand Down
16 changes: 16 additions & 0 deletions docs/4/change-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,22 @@ title: v4 Change Log

This page lists changes which have happened between releases.

### InspIRCd 4.0.0rc2

**This release candidate version of InspIRCd was released on 2024-06-14.**

- Fixed formatting the user count percentage in `/MAP`.

- Fixed some references to --debug that should be --protocoldebug now.

- Fixed various compiler warnings.

- Moved the `/GLOBAL` alias to the generic services config file.

- Removed host-based cloak data from the hmac-sha256-addr link data.

- Renamed the regex_pcre module back to regex_pcre2 to avoid upgrading issues.

### InspIRCd 4.0.0rc1

**This release candidate version of InspIRCd was released on 2024-06-07.**
Expand Down
2 changes: 1 addition & 1 deletion docs/4/configuration/_log.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ details: |+
m_password_hash | normal | Messages relating to [the password_hash module](/4/modules/password_hash).
m_permchannels | critical<br>warning<br>debug | Messages relating to [the permchannels module](/4/modules/permchannels).
m_pgsql | critical<br>normal<br>debug | Messages relating to [the pgsql module](/4/modules/pgsql).
m_regex_pcre | normal | Messages relating to [the regex_pcre module](/4/modules/regex_pcre).
m_regex_pcre2 | normal | Messages relating to [the regex_pcre2 module](/4/modules/regex_pcre2).
m_sasl | normal<br>debug | Messages relating to [the sasl module](/4/modules/sasl).
m_services | debug | Messages relating to [the services module](/4/modules/services).
m_showfile | warning | Messages relating to [the showfile module](/4/modules/showfile).
Expand Down
2 changes: 1 addition & 1 deletion docs/4/modules/_regex_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The following regular expression engines are included with InspIRCd:
Engine | Module | Description
-------- | --------------------------------------- | -----------
glob | [regex_glob](/4/modules/regex_glob) | Matches using a glob pattern.
pcre | [regex_pcre](/4/modules/regex_pcre) | Matches using a [PCRE](https://www.debuggex.com/cheatsheet/regex/pcre) regular expression.
pcre | [regex_pcre2](/4/modules/regex_pcre2) | Matches using a [PCRE](https://www.debuggex.com/cheatsheet/regex/pcre) regular expression.
posix | [regex_posix](/4/modules/regex_posix) | Matches using a [POSIX](http://man7.org/linux/man-pages/man7/regex.7.html) regular expression.
re2 | [regex_re2](/4/modules/regex_re2) | Matches using a [RE2](https://github.com/google/re2/wiki/Syntax) regular expression.
stdregex | [regex_stdlib](/4/modules/regex_stdlib) | Matches using a [C++11 `std::regex`](http://cpprocks.com/files/c++11-regex-cheatsheet.pdf) regular expression.
2 changes: 1 addition & 1 deletion docs/4/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Name | Description
[log_syslog](/4/modules/log_syslog) | Provides the ability to log to syslog.
[mysql](/4/modules/mysql) | Provides the ability for SQL modules to query a MySQL database.
[pgsql](/4/modules/pgsql) | Provides the ability for SQL modules to query a PostgreSQL database.
[regex_pcre](/4/modules/regex_pcre) | Provides the pcre regular expression engine which uses the PCRE2 library.
[regex_pcre2](/4/modules/regex_pcre2) | Provides the pcre regular expression engine which uses the PCRE2 library.
[regex_posix](/4/modules/regex_posix) | Provides the posix regular expression engine which uses the POSIX.2 regular expression matching system.
[regex_re2](/4/modules/regex_re2) | Provides the re2 regular expression engine which uses the RE2 library.
[sqlite3](/4/modules/sqlite3) | Provides the ability for SQL modules to query a SQLite 3 database.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: regex_pcre
name: regex_pcre2

introduction: ""

depends_on:
what: a third-party library ([PCRE](https://www.pcre.org))
what: a third-party library ([PCRE2](https://www.pcre.org))

description: |-
This module provides the `pcre` regular expression engine which uses the [PCRE2](https://www.pcre.org) library.
2 changes: 1 addition & 1 deletion docs/4/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Services can now grant services privileges to users remotely (requires the [serv

Regular expression support has been entirely rewritten with support for captures and flags.

The regex_pcre and regex_tre modules have been moved to inspircd-contrib as their dependencies are deprecated. It is recommended that you migrate to the [regex_pcre2](/4/modules/regex_pcre) and [regex_stdlib](/4/modules/regex_stdlib) modules respectively.
The regex_pcre and regex_tre modules have been moved to inspircd-contrib as their dependencies are deprecated. It is recommended that you migrate to the [regex_pcre2](/4/modules/regex_pcre2) and [regex_stdlib](/4/modules/regex_stdlib) modules respectively.

[The regex_stdlib module](/4/modules/regex_stdlib) is now always built on all platforms. This is now the recommended regex module.

Expand Down

0 comments on commit 8df0aab

Please sign in to comment.