summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDonald Sharp <sharpd@cumulusnetworks.com>2021-05-04 13:05:24 +0200
committerGitHub <noreply@github.com>2021-05-04 13:05:24 +0200
commitfc1391a84078589f1be8b44b705fca21cf07616e (patch)
tree94ed01bd46e3ff6b175cffbf6911b8b40963cfb8 /doc
parentMerge pull request #8606 from donaldsharp/peer_cleanups (diff)
parenttests: add scapy to topotests Docker (diff)
downloadfrr-fc1391a84078589f1be8b44b705fca21cf07616e.tar.xz
frr-fc1391a84078589f1be8b44b705fca21cf07616e.zip
Merge pull request #8617 from opensourcerouting/pim-bsm-cleanup
lib, pimd: move bsm code to typesafe lists
Diffstat (limited to 'doc')
-rw-r--r--doc/developer/lists.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/developer/lists.rst b/doc/developer/lists.rst
index 86db788c0..553bd1f59 100644
--- a/doc/developer/lists.rst
+++ b/doc/developer/lists.rst
@@ -108,6 +108,8 @@ Functions provided:
| _first, _next, _next_safe, | yes | yes | yes | yes | yes |
| _const_first, _const_next | | | | | |
+------------------------------------+------+------+------+---------+------------+
+| _swap_all | yes | yes | yes | yes | yes |
++------------------------------------+------+------+------+---------+------------+
| _add_head, _add_tail, _add_after | yes | -- | -- | -- | -- |
+------------------------------------+------+------+------+---------+------------+
| _add | -- | yes | yes | yes | yes |
@@ -322,6 +324,14 @@ The following documentation assumes that a list has been defined using
return ``item``. The function may also call ``assert()`` (but most
don't.)
+.. c:function:: itemtype *Z_swap_all(struct Z_head *, struct Z_head *)
+
+ Swap the contents of 2 containers (of identical type). This exchanges the
+ contents of the two head structures and updates pointers if necessary for
+ the particular data structure. Fast for all structures.
+
+ (Not currently available on atomic containers.)
+
.. todo::
``Z_del_after()`` / ``Z_del_hint()``?