proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-05 20:51:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Some minor doc cleanup for new data structures

Browse Source 
Noticed during attempts at usage that the documentation
needed a couple small updates:

1) Tell the user which header to include
2) Some functions want the address of the data structure

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
This commit is contained in:
Donald Sharp 2019-04-30 17:56:05 -04:00
parent 5390986617
commit 820b3b6596
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/developer/lists.rst
View File

@ -119,6 +119,8 @@ The common setup pattern will look like this:
.. code-block:: c
#include <typesafe.h>
PREDECL_XXX(Z)
struct item {
int otherdata;
@ -159,26 +161,26 @@ Common iteration macros
The following iteration macros work across all data structures:
.. c:function:: for_each(Z, head, item)
.. c:function:: for_each(Z, &head, item)
Equivalent to:
.. code-block:: c
for (item = Z_first(head); item; item = Z_next(head, item))
for (item = Z_first(&head); item; item = Z_next(&head, item))
Note that this will fail if the list is modified while being iterated
over.
.. c:function:: for_each_safe(Z, head, item)
.. c:function:: for_each_safe(Z, &head, item)
Same as the previous, but the next element is pre-loaded into a "hidden"
variable (named ``Z_safe``.) Equivalent to:
.. code-block:: c
for (item = Z_first(head); item; item = next) {
next = Z_next_safe(head, item);
for (item = Z_first(&head); item; item = next) {
next = Z_next_safe(&head, item);
...
}
@ -189,7 +191,7 @@ The following iteration macros work across all data structures:
tables is resized while iterating. This will cause items to be
skipped or iterated over twice.
.. c:function:: for_each_from(Z, head, item, from)
.. c:function:: for_each_from(Z, &head, item, from)
Iterates over the list, starting at item ``from``. This variant is "safe"
as in the previous macro. Equivalent to:
@ -197,7 +199,7 @@ The following iteration macros work across all data structures:
.. code-block:: c
for (item = from; item; item = from) {
from = Z_next_safe(head, item);
from = Z_next_safe(&head, item);
...
}