From: Alan T. DeKok <aland@freeradius.org>
Date: Fri, 21 Jun 2024 16:12:28 +0000 (-0400)
Subject: add more documentation
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ec73e1a610dbaf05fe44ace98ecf7bb53c2f38e6;p=thirdparty%2Ffreeradius-server.git

add more documentation
---

diff --git a/doc/antora/modules/reference/pages/dictionary/attribute.adoc b/doc/antora/modules/reference/pages/dictionary/attribute.adoc
index a300d82dbe1..2e51cb0ef3e 100644
--- a/doc/antora/modules/reference/pages/dictionary/attribute.adoc
+++ b/doc/antora/modules/reference/pages/dictionary/attribute.adoc
@@ -51,15 +51,18 @@ Common flags and meanings
 |=====
 | Name           | Description
 | `array`        | For fixed-size types, declare that the contents of the packet can have an array of this value.
-| `enum=<ref>`   | For "leaf" types, copy xref:dictionary/value.adoc[VALUE]s from an xref:dictionary/enum.adoc[ENUM] or other attribute.
 | `clone=<ref>`  | For `tlv` or 'struct' types, clone (or copy) child definitions from another attribute of the same type
+| `concat`       | For `octet` data types, the server will automatically split/merge values into attributes.
+| `counter`      | For numeric data types, treat the values as SNMP-style counters, which can be automatically added.
+| `enum=<ref>`   | For "leaf" types, copy xref:dictionary/value.adoc[VALUE]s from an xref:dictionary/enum.adoc[ENUM] or other attribute.
 | `internal`     | This attribute is internal to the server, and will never be sent "on the wire"
 | `ref=<ref>`    | For `group` types, the referenced attributes will be allowed in the group
+| `secret`       | The server will not print `secret` values in debug mode, and in many other situations.
 |=====
 
 The `<ref>` field in the examples above is an attribute references such as `Foo`, or `Foo.Bar`, or `dhcpv4.foo.bar`.
 
-The `enum` and `clone` flags are essentially the same, in that they copy "children" of the attribute.  However, the `enum` flag copies values, and `clone` copies attributes.
+The `enum` and `clone` flags are similar, in that they copy "children" of the attribute.  However, the `enum` flag copies values, and `clone` copies attributes.
 
 .Examples
 ----
diff --git a/doc/antora/modules/reference/pages/dictionary/struct.adoc b/doc/antora/modules/reference/pages/dictionary/struct.adoc
index 158b7742a0a..8558ad50279 100644
--- a/doc/antora/modules/reference/pages/dictionary/struct.adoc
+++ b/doc/antora/modules/reference/pages/dictionary/struct.adoc
@@ -47,8 +47,9 @@ Common flags and meanings
 [cols="30%,70%"]
 |=====
 | Name             | Description
-| `length=uint8`  | When encoding or decoding the structure, it is prefixed by a `uint8` field containing the length of the structure.
+| `length=uint8`   | When encoding or decoding the structure, it is prefixed by a `uint8` field containing the length of the structure.
 | `length=uint16`  | When encoding or decoding the structure, it is prefixed by a `uint16` field containing the length of the structure.
+| `offset=<number>` | When encoding or decoding the structure, add `number` to the value in the `length` field.
 |=====