From 39909f9fb9459ce210cb44a10291a053d4fbb272 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Thu, 6 Mar 2025 21:43:10 -0500 Subject: [PATCH 1/3] doc: Add typesafe conversion examples Try to give some good examples of various lists being converted over to the typesafe way of doing things. Signed-off-by: Donald Sharp --- doc/developer/lists.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) 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 ----------------------- From 4738cb51d2019e8852887e97e9a0363ec29728a4 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Thu, 6 Mar 2025 21:49:12 -0500 Subject: [PATCH 2/3] doc: Developer documentation missing some build instructions The building-frr-for-ubuntu2404 and building-doc were missing from the compilation of developer documents. Signed-off-by: Donald Sharp --- doc/developer/building.rst | 2 ++ 1 file changed, 2 insertions(+) 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 From f1c75deb8e6581b0c3eb2129a61c017ca1d9be99 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Thu, 6 Mar 2025 21:54:42 -0500 Subject: [PATCH 3/3] doc: The sbfd documentation was not being included Add the sbfd documentation, such as it is, to the developer documentation so that it can be read by people. Signed-off-by: Donald Sharp --- doc/developer/index.rst | 1 + doc/user/protocols.rst | 1 + 2 files changed, 2 insertions(+) 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/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