summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Stapp <mjs.ietf@gmail.com>2025-03-07 11:44:00 -0500
committerGitHub <noreply@github.com>2025-03-07 11:44:00 -0500
commit5af56c8bc9de33bb5405bce127bc3f73f1723f49 (patch)
tree029c3c6ad2e23d641d3272259d7dca03f71a37fd /doc
parentb221fd5f6c556f52124f1247138c6de4ca8db447 (diff)
parentf1c75deb8e6581b0c3eb2129a61c017ca1d9be99 (diff)
Merge pull request #18338 from donaldsharp/documentation_typesafe
Documentation typesafe
Diffstat (limited to 'doc')
-rw-r--r--doc/developer/building.rst2
-rw-r--r--doc/developer/index.rst1
-rw-r--r--doc/developer/lists.rst11
-rw-r--r--doc/user/protocols.rst1
4 files changed, 15 insertions, 0 deletions
diff --git a/doc/developer/building.rst b/doc/developer/building.rst
index 6762604f32..6c9f7be7f7 100644
--- a/doc/developer/building.rst
+++ b/doc/developer/building.rst
@@ -32,5 +32,7 @@ Building FRR
building-frr-for-ubuntu1804
building-frr-for-ubuntu2004
building-frr-for-ubuntu2204
+ building-frr-for-ubuntu2404
building-docker
cross-compiling
+ building-doc
diff --git a/doc/developer/index.rst b/doc/developer/index.rst
index bd794b11a8..528d520ba9 100644
--- a/doc/developer/index.rst
+++ b/doc/developer/index.rst
@@ -24,3 +24,4 @@ FRRouting Developer's Guide
pceplib
link-state
northbound/northbound
+ sbfd
diff --git a/doc/developer/lists.rst b/doc/developer/lists.rst
index ccac10aab9..b761cc3671 100644
--- a/doc/developer/lists.rst
+++ b/doc/developer/lists.rst
@@ -187,6 +187,17 @@ To switch between compatible data structures, only these two lines need to be
changes. To switch to a data structure with a different API, some source
changes are necessary.
+As a example to the developer here are some example commits that convert
+over to usage of the typesafe data structures:
+
++------------------------------------------------------+------------------------------------+
+| Commit Message | SHA |
++======================================================+====================================+
+| bgpd: Convert the bgp_advertise_attr->adv to a fifo | b2e0c12d723a6464f67491ceb9 |
++------------------------------------------------------+------------------------------------+
+| zebra: convert LSP nhlfe lists to use typesafe lists | ee70f629792b90f92ea7e6bece |
++------------------------------------------------------+------------------------------------+
+
Common iteration macros
-----------------------
diff --git a/doc/user/protocols.rst b/doc/user/protocols.rst
index e571cd66fc..fcddf1990c 100644
--- a/doc/user/protocols.rst
+++ b/doc/user/protocols.rst
@@ -9,6 +9,7 @@ Protocols
zebra
bfd
+ sbfd
bgp
babeld
fabricd