From: Alan T. DeKok <aland@freeradius.org>
Date: Sun, 8 Sep 2024 14:32:29 +0000 (-0400)
Subject: typos and fixes
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5d3c4499227fdfdec75649d9da2863352663cab5;p=thirdparty%2Ffreeradius-server.git

typos and fixes
---

diff --git a/doc/antora/modules/reference/pages/dictionary/begin-tlv.adoc b/doc/antora/modules/reference/pages/dictionary/begin-tlv.adoc
index c690dec7696..87937bbd012 100644
--- a/doc/antora/modules/reference/pages/dictionary/begin-tlv.adoc
+++ b/doc/antora/modules/reference/pages/dictionary/begin-tlv.adoc
@@ -66,9 +66,9 @@ The above example is equivalent to the example below.
 .Example
 ----
 ATTRIBUTE Foo 2 tlv
-ATTRIBUTE Foo.Bar 2.1 string
-ATTRIBUTE Foo.Baz 2.2 tlv
-ATTRIBUTE Foo.Baz.Such 2.2.4 ipaddr
+ATTRIBUTE Bar .1 string
+ATTRIBUTE Baz .2 tlv
+ATTRIBUTE Such .2.4 ipaddr
 ----
 
 For short entries, it can be simpler to use the full name an OID.
diff --git a/doc/antora/modules/reference/pages/dictionary/struct.adoc b/doc/antora/modules/reference/pages/dictionary/struct.adoc
index 8558ad50279..cee5de471eb 100644
--- a/doc/antora/modules/reference/pages/dictionary/struct.adoc
+++ b/doc/antora/modules/reference/pages/dictionary/struct.adoc
@@ -53,15 +53,26 @@ Common flags and meanings
 |=====
 
 
-.Examples
+The following example shows how one structure can include another one.  In this example, the `Information` structure has two fields: `Type` and `Other`.  It has two possible sub-structures which can appear after the `Other` field.  Which sub-structure to be decoded is defined by the `key` field: `Type`.
+
+.Example of a Key field
 ----
 ATTRIBUTE Information 1 struct
 MEMBER Type uint8 key
+MEMBER Other uint32
 
 STRUCT Foo Type 1
 MEMBER Bar uint16
 MEMBER Baz uint16
+
+STRUCT Blag Type 2
+MEMBER Whoops uint32
+MEMBER Stuff uint8
 ----
 
+== Caveats
+
+Variable-sized fields such as `tlv`, `struct`, `string`, or `octets` can only be placed at the end of the `struct`.
+
 // Copyright (C) 2023 Network RADIUS SAS.  Licenced under CC-by-NC 4.0.
 // This documentation was developed by Network RADIUS SAS.