]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
now that we suppress stupid warnings, fix the docs
authorAlan T. DeKok <aland@freeradius.org>
Fri, 16 Aug 2019 14:56:02 +0000 (10:56 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Fri, 16 Aug 2019 14:56:02 +0000 (10:56 -0400)
perl -p -i -e 's/`\+\%{(.*?)}\+`/`%{$1}`/g' $(find . -name "*.adoc" -print)

doc/antora/modules/unlang/pages/regex.adoc
doc/antora/modules/unlang/pages/xlat/alternation.adoc
doc/antora/modules/unlang/pages/xlat/attribute.adoc
doc/antora/modules/unlang/pages/xlat/index.adoc
doc/antora/modules/unlang/pages/xlat/module.adoc
doc/antora/modules/unlang/pages/xlat/predefined.adoc
doc/antora/modules/upgrade/pages/index.adoc

index 8870f1fd760903dc3c49ceef9d343b707f17ccee..97bcbc9d57b7a784fee1e1a5f7fc75818a979a9f 100644 (file)
@@ -113,13 +113,13 @@ library the server was built with.  Multiple flags may be specified per
 When the `=~` or `!~` operators are used, then parentheses in the regular
 expression will sub capture groups, which contain part of the subject string.
 
-The special expansion `+%{0}+` expands to the portion of the subject that
+The special expansion `%{0}` expands to the portion of the subject that
 matched. The expansions +
-`+%{1}+`..`+%{32}+` expand to the contents of any subcapture groups.
+`%{1}`..`%{32}` expand to the contents of any subcapture groups.
 
 When using libpcre[2], named capture groups may also be accessed using the
 built-in expansion +
-`+%{regex:<named capture group>}+`.
+`%{regex:<named capture group>}`.
 
 Please see the xref:xlat/predefined.adoc#_0_32[xlat documentation] for
 more information on regular expression matching.
index 897ca903510835bed33524f6a80a442820ed4678..cba645331b898f32704f26a6cda64481dd4aabaf 100644 (file)
@@ -3,22 +3,22 @@
 Alternation syntax similar to that used in Unix shells may also be
 used:
 
-`+%{%{Foo}:-bar}+`
+`%{%{Foo}:-bar}`
 
-This code returns the value of `+%{Foo}+`, if it has a value.
+This code returns the value of `%{Foo}`, if it has a value.
 Otherwise, it returns a literal string bar.
 
-`+%{%{Foo}:-%{Bar}}+`
+`%{%{Foo}:-%{Bar}}`
 
-This code returns the value of `+%{Foo}+`, if it has a value.
-Otherwise, it returns the expansion of `+%{Bar}+`.
+This code returns the value of `%{Foo}`, if it has a value.
+Otherwise, it returns the expansion of `%{Bar}`.
 
 These conditional expansions can be nested to almost any depth, such
-as with `+%{%{One}:-%{%{Two}:-%{Three}}}+`.
+as with `%{%{One}:-%{%{Two}:-%{Three}}}`.
 
 .Examples
-`+%{%{Stripped-User-Name}:-%{User-Name}}+` +
-`+%{%{Framed-IP-Address}:-<none>}+`
+`%{%{Stripped-User-Name}:-%{User-Name}}` +
+`%{%{Framed-IP-Address}:-<none>}`
 
 // Copyright (C) 2019 Network RADIUS SAS.  Licenced under CC-by-NC 4.0.
 // Development of this documentation was sponsored by Network RADIUS SAS.
index 83c0e5c88d14f60e4faa68adfd457a3d53252ca8..b0ce5d24d96c06259694addc620e8c80d164929c 100644 (file)
@@ -3,8 +3,8 @@
 Attributes in a list may be referenced via one of the following two
 syntaxes:
 
-`+%{Attribute-Name}+` +
-`+%{<list>:Attribute-Name}+`
+`%{Attribute-Name}` +
+`%{<list>:Attribute-Name}`
 
 The `<list>:` prefix is optional. If given, it must be a valid
 reference to an xref:list.adoc[attribute list].
@@ -24,9 +24,9 @@ reference is replacedd with an empty string.
 
 .Examples
 
-`+%{User-Name}+` +
+`%{User-Name}` +
 `+%{request:User-Name} # same as above+` +
-`+%{reply:User-Name}+` +
+`%{reply:User-Name}` +
 `+%{outer.request:User-Name} # from inside of a TTLS/PEAP tunnel+`
 
 Examples of using references inside of a string:
index 4180f566e4955405d6cd61d7ccc117f01cefebbc..297cd69139043242fc94948190d0b7b91506e73b 100644 (file)
@@ -27,7 +27,7 @@ This feature is used to create policies which refer to concepts rather
 than to specific values. For example, a policy can be created that
 refers to the User-Name in a request, via:
 
-`+%{User-Name}+`
+`%{User-Name}`
 
 This string expansion is done only for double-quoted strings and for
 the back-tick operator.
index 93d5792667282f2b9b1997c35940607c7b1a2268..f48379d4835572bd90e3f1aa21388eacd3c060ed 100644 (file)
@@ -12,7 +12,7 @@ expanded to allow for additional flexibility.
 
 .Examples
 
-`+%{sql:SELECT name FROM mytable WHERE username = %{User-Name}}+`
+`%{sql:SELECT name FROM mytable WHERE username = %{User-Name}}`
 
 // Copyright (C) 2019 Network RADIUS SAS.  Licenced under CC-by-NC 4.0.
 // Development of this documentation was sponsored by Network RADIUS SAS.
index b1ce65b3112b09f521ec4f40f040167bcce5c908..49fdec302b44ad379d1bbaed0c30c07771f8f0ea 100644 (file)
@@ -767,8 +767,8 @@ The md5 of Caipirinha in hex is 14840b6d647c7c98a3e732f833d86ea9
 
 === +%{0}+..+%{32}+
 
-`+%{0}+` expands to the portion of the subject that matched the last regular
-expression evaluated. `+%{1}+`..`+%{32}+` expand to the contents of any capture
+`%{0}` expands to the portion of the subject that matched the last regular
+expression evaluated. `%{1}`..`%{32}` expand to the contents of any capture
 groups in the pattern.
 
 Every time a regular expression is evaluated, whether it matches or not,
@@ -841,7 +841,7 @@ The destination IPv4 or IPv6 address of the packet. See also the
 expansions `%{listen:ipaddr}` and `%{listen:ipv6addr}`. If the socket
 is listening on a "wildcard" address, then these two expansions will be
 different, as follows: the `%{listen:ipaddr}` will be the wildcard
-address and `+%{Packet-DST-IP-Address}+` will be the unicast address to
+address and `%{Packet-DST-IP-Address}` will be the unicast address to
 which the packet was sent.
 
 === +%{Packet-SRC-Port} and %{Packet-DST-Port}+
index 6c632baa96f8cd29029990a86146c242796653d7..75ae0c300a43b55046b2ff235bd862a6b8b11fbc 100644 (file)
@@ -383,7 +383,7 @@ The v3 server has warned about using non prefixed attribute references
 for some time. If users have paid attention to those warnings, few
 modifications will be required.
 
-Use of attributes in xlats e.g. `+%{User-Name}+` remains unchanged.
+Use of attributes in xlats e.g. `%{User-Name}` remains unchanged.
 There is no plan to require prefixes here.
 
 As of v3, the preferred format for `+unknown+` attributes is
@@ -570,10 +570,10 @@ checks to see if you want to execute the module.
 Allow `+&Attr-Name[*]+` to mean _sum_. Previously, it just referred to
 the first attribute.
 
-Using `+%{expr:0 + &Attr-Name[*]}+` will cause it to return the sum of
+Using `%{expr:0 + &Attr-Name[*]}` will cause it to return the sum of
 the values of all attributes with the given name.
 
-Note that `+%{expr:1 * &Attr-Name[*]}+` does _not_ mean repeated
+Note that `%{expr:1 * &Attr-Name[*]}` does _not_ mean repeated
 multiplication. Instead, the sum of the attributes is taken as before,
 and then the result is multiplied by one.