From 871d8c5653aeb48d1d1ad322ec7f078287f80c0f Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <progval+git@progval.net>
Date: Sat, 14 Dec 2024 17:24:11 +0100
Subject: [PATCH] Fix RPL_LINKS param list, and provide an example

This now conforms to what Charybdis/Hybrid/Plexus4/Solanum, InspIRCd, irc2, ngIRCd,
and UnrealIRCd do.

Bahamut and ircu2/Nefarious do not support LINKS at all.
---
 _includes/messages/optional.md | 6 ++++++
 _includes/modern-appendix.md   | 5 +++--
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/_includes/messages/optional.md b/_includes/messages/optional.md
index 9552af2..7a8e1f2 100644
--- a/_includes/messages/optional.md
+++ b/_includes/messages/optional.md
@@ -39,6 +39,12 @@ Numeric Replies:
 * {% numeric RPL_LINKS %}
 * {% numeric RPL_ENDOFLINKS %}
 
+Reply Example:
+
+     :My.Little.Server 364 nick services.example.org My.Little.Server :1 Anope IRC Services
+     :My.Little.Server 364 nick My.Little.Server My.Little.Server :0 test server
+     :My.Little.Server 365 nick * :End of /LINKS list.
+
 ### USERHOST message
 
          Command: USERHOST
diff --git a/_includes/modern-appendix.md b/_includes/modern-appendix.md
index 2573891..ef87661 100644
--- a/_includes/modern-appendix.md
+++ b/_includes/modern-appendix.md
@@ -677,9 +677,10 @@ Sent as a reply to the {% message NAMES %} command, this numeric lists the clien
 
 {% numericheader RPL_LINKS %}
 
-      "<client> * <server> :<hopcount> <server info>"
+      "<client> <server1> <server2> :<hopcount> <server info>"
 
-Sent as a reply to the {% message LINKS %} command, this numeric specifies one of the known servers on the network.
+Sent as a reply to the {% message LINKS %} command, this numeric specifies servers `<server1>` and `<server2>` are linked together.
+For servers which follow a spanning tree topology, `<server2>` is the closest to the client.
 
 `<server info>` is a string containing a description of that server.