From: Alan T. DeKok <aland@freeradius.org>
Date: Thu, 1 May 2025 11:01:17 +0000 (-0400)
Subject: document timeout rcode
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=26a78ea91b4b93bb22cf96aaa43e99c75a32ca18;p=thirdparty%2Ffreeradius-server.git

document timeout rcode
---

diff --git a/doc/antora/modules/reference/partials/rcode_table.adoc b/doc/antora/modules/reference/partials/rcode_table.adoc
index d906085449..3463def004 100644
--- a/doc/antora/modules/reference/partials/rcode_table.adoc
+++ b/doc/antora/modules/reference/partials/rcode_table.adoc
@@ -2,6 +2,10 @@
 [cols="15%,85%"]
 |=====
 | Return code   | Description
+| `disallow`    | Access to a particular resource is
+                  denied. This is similar to `reject` but is the result
+                  of an authorizational check failing, as opposed to
+                  credentials being incorrect.
 | `fail`	| The operation failed.  Usually as a result of an
                   external dependency like a database being unavailable
                   or an internal error.
@@ -13,27 +17,23 @@
                   attribute values.
 | `noop`        | The operation did nothing.
 | `notfound`    | A 'lookup' operation returned no results.
-| `ok`          | Operation completed successfully but did not change any
-                  attributes in the request.
+| `ok`          | Operation completed successfully.
 | `reject`      | The operation indicates the current request should be
                   'rejected'.  What this actually means is different from
                   protocol to protocol.  It usually means that access to
                   the requested resource should be denied, or that the
                   current request should be NAKd.  Usually returned when
                   provided credentials were invalid.
+| `timeout`     | The operation failed due to a timeout.
 | `updated`     | The operation completed successfully and updated one
                   or more attributes in the request.
-| `disallow`    | Access to a particular resource is
-                  denied. This is similar to `reject` but is the result
-                  of an authorizational check failing, as opposed to
-                  credentials being incorrect.
 | `yield`       | Returned by an operation when execution of a request should
                   be suspended.
 |=====
 
 [NOTE]
 ====
-In versions ≤ v3.2.x the `disallow` rcode was called `userlock`. `disallow` and
+In versions before 4.0, the `disallow` rcode was called `userlock`. The terms `disallow` and
 `userlock` have an identical meaning. `disallow` will be returned in any
 instance where `userlock` was returned in v3.0.x or v3.2.x
 ====