From: Nick Porter Date: Wed, 1 Mar 2023 16:40:52 +0000 (+0000) Subject: docs: Fix antora errors X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e745f3cf8a4a4b620a7d59981e13e14e11b992c8;p=thirdparty%2Ffreeradius-server.git docs: Fix antora errors --- diff --git a/doc/antora/modules/ROOT/pages/index.adoc b/doc/antora/modules/ROOT/pages/index.adoc index 4257a365686..9c2350e21ad 100644 --- a/doc/antora/modules/ROOT/pages/index.adoc +++ b/doc/antora/modules/ROOT/pages/index.adoc @@ -1,3 +1,5 @@ += Introduction + [WARNING] ==== *VERSION 4 IS IN DEVELOPMENT AND HAS NOT BEEN OFFICIALLY @@ -9,8 +11,6 @@ documentation may change. Please wait for an official release before using version 4. ==== -= Introduction - This is the documentation for FreeRADIUS, version 4. The documentation is available under the Creative Commons Non-Commercial license, as given in the `LICENSE` file in this directory. diff --git a/doc/antora/modules/developers/pages/sbuff-ng.adoc b/doc/antora/modules/developers/pages/sbuff-ng.adoc index 937307aaffb..121be9c0086 100644 --- a/doc/antora/modules/developers/pages/sbuff-ng.adoc +++ b/doc/antora/modules/developers/pages/sbuff-ng.adoc @@ -1,6 +1,6 @@ # Current sbuff failings -# The major issues with the current sbuffs are +## The major issues with the current sbuffs are - Markers need to be released before the function they're created in returns. This means we often create temporary `fr_sbuff_t` on the stack which is inefficient. - Using pointers often results in abuse, i.e. people storing pointers pointing into the underlying char buffer. @@ -10,8 +10,8 @@ - Last matched token isn't stored anywhere, so the caller of a parsing function needs to check the current position of an sbuff against its tokens. - Returning negative offsets to indicate error positions dosn't work when there are transform functions in the sbuff chain. -# Fixes -## Marker release +## Fixes +### Marker release Current sbuffs require markers to be tracked because the marker's pointer needs to be updated is the sbuff is shifted, @@ -25,7 +25,7 @@ typedef struct { } sbuff_marker_t; ---- -## Pointer abuse +### Pointer abuse In almost every instance a "legacy" C function that's operating on a standard C buffer takes a `buffer` and a `length`. @@ -41,7 +41,7 @@ result in a syntax error. Standard copy functions could copy data from one "parsing" sbuff to a "printing" sbuff which wrapped a buffer on the stack. Printing sbuffs could also be setup to do standard escaping for \0, making the string "c safe". -## Overzealous pinning +### Overzealous pinning The key to fixing the pinning problem is to allow backtracking. @@ -160,7 +160,7 @@ One concern is a `parent_start` offset falling in the middle of an atom in the p transform function is broken. i.e. if a transform function provides the `\` from `\t` in its output buffer, then the transform function must be rewritten. The output buffer of a transform sbuff must contain only complete, transformed, atoms. -## Shifting data out of sbuffs is expensive +### Shifting data out of sbuffs is expensive The reason why it's expensive is because the entire sbuff chain needs to have its pointers updated. If every sbuff maintains positions using offsets, only the start and end offsets need to be changed. This gives a real advantage to using markers, @@ -169,7 +169,7 @@ as they will never need to be updated during shifts. marker's offsets remain re If `sbuff->offset < sbuff->start`, this event would trigger a backtrack. -## Pasing terminal sequences and escape rules into functions is awful +### Pasing terminal sequences and escape rules into functions is awful Text transformation must be transparent to the parsing function, anything else will not function correctly, or will add horendous complexity. @@ -213,7 +213,7 @@ Here `tmpl_afrom_substr` would be completely unaware it was processing a double (we need to do that so it can find xlats). All unescaping and terminal sequence location is done transparently, and `tmpl_afrom_substr` only sees the unescaped byte stream. -## Negative offsets don't work when transform sbuffs are used +### Negative offsets don't work when transform sbuffs are used One key realisation is that returning negative offsets up the call stack will not work when the offsets don't map 1:1 between parent and child. diff --git a/doc/antora/modules/raddb/pages/mods-available/eap.adoc b/doc/antora/modules/raddb/pages/mods-available/eap.adoc index ea44ccac3c2..1ffa60b122e 100644 --- a/doc/antora/modules/raddb/pages/mods-available/eap.adoc +++ b/doc/antora/modules/raddb/pages/mods-available/eap.adoc @@ -160,6 +160,7 @@ want. ==== As of 4.0 the following TLS config items/config sections have been removed. Equivalent functionality is available. +==== [options="header,autowidth"] |=== diff --git a/raddb/mods-available/eap b/raddb/mods-available/eap index 43d25df8099..30a6e58b950 100644 --- a/raddb/mods-available/eap +++ b/raddb/mods-available/eap @@ -188,6 +188,7 @@ eap { # ==== # As of 4.0 the following TLS config items/config sections have been # removed. Equivalent functionality is available. + # ==== # # [options="header,autowidth"] # |===