summaryrefslogtreecommitdiff
path: root/doc/developer/lists.rst
AgeCommit message (Collapse)Author
2025-03-09doc: Add typesafe conversion examplesDonald Sharp
Try to give some good examples of various lists being converted over to the typesafe way of doing things. Signed-off-by: Donald Sharp <sharpd@nvidia.com> (cherry picked from commit 39909f9fb9459ce210cb44a10291a053d4fbb272)
2022-04-19doc: Fix spelling of choosenDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2022-04-19*: Fix spelling of neccessaryDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2022-03-12doc/developer: remove outdated paragraphDavid Lamparter
We have `_anywhere` and `_member` now, so this has become outdated. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2022-03-12doc/developer: reword list -> containerDavid Lamparter
For some reason I couldn't think of the word "container" back when I wrote most of this. It is the proper term most developers wil understand correctly, so let's use it. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2022-03-12lib: add `_last` and `_prev` on typesafe RB/DLISTDavid Lamparter
RB-tree and double-linked-list easily support backwards iteration, and an use case seems to have popped up. Let's make it accessible. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-10-19doc/developer: add _member and _anywhereDavid Lamparter
New members in the typesafe.h API club. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-10-14doc/developer: fix duplicate const prototypesDavid Lamparter
The const ones have const in the name. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-10-14doc/developer: use :c:macro: where appropriateDavid Lamparter
Sphinx tries to parse :c:function: as function prototype, which doesn't quite work with macros. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-05-03lib: add *_swap_all to typesafe containersDavid Lamparter
Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2021-03-17*: require semicolon after DEFINE_<typesafe...>David Lamparter
Again, see previous commits. Signed-off-by: David Lamparter <equinox@diac24.net>
2020-09-08doc: add notes about hash table invariantsQuentin Young
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-05-04lib: add const iteration & find to typesafe listsDavid Lamparter
Based on work originally by Mark Stapp <mjs@voltanet.io>. Make it possible to iterate the typesafe lists in a const context, as well as find items from them. Signed-off-by: Mark Stapp <mjs@voltanet.io> [above signoff was for the original version before modification] Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2020-02-14doc: Fixup some missing syntaxDonald Sharp
We were missing some syntax indicators for stuff in doc/developer add them in. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-08-01doc: add a small FAQ for the typesafe datastructsDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>
2019-05-25doc: Update docs to represent changes on the groundDonald Sharp
The lists documentation had not been updated to represent the for_eachXXX to frr_eachXXX changes. Make it so. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-21lib: add DECLARE_HEAP datastructureDavid Lamparter
This is an 8-ary heap (cacheline optimized.) It works as a semi-sorted kind of middle ground between unsorted and sorted datastructures; pop() always returns the lowest item but ordering is only loosely enforced. Signed-off-by: David Lamparter <equinox@diac24.net>
2019-05-21lib: add DECLARE_DLIST (double-linked list)David Lamparter
Turns out we need one of these. Same API as DECLARE_LIST, but deleting random items is much faster. Signed-off-by: David Lamparter <equinox@diac24.net>
2019-05-02doc: Some minor doc cleanup for new data structuresDonald Sharp
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>
2019-05-02Revert "Zebra diet"Lou Berger
2019-05-01doc: Some minor doc cleanup for new data structuresDonald Sharp
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>
2019-04-27doc: add developer docs for type-safe listsDavid Lamparter
Signed-off-by: David Lamparter <equinox@diac24.net>