doc: Modify typesafe documentation

The typesafe documentation needs a bit of warning about
how they can cause problems on conversion.

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
This commit is contained in:
Donald Sharp 2025-03-18 13:56:28 -04:00
parent f3d9bd90a1
commit 6940c1923b

View file

@ -773,6 +773,20 @@ Why is it ``PREDECL`` + ``DECLARE`` instead of ``DECLARE`` + ``DEFINE``?
2 ``.c`` files, but only **if the macro arguments are identical.** Maybe
don't do that unless you really need it.
COMMON PROBLEMS
---------------
The ``fini`` call of the various typesafe structures actually close the data
structure off and attempts to use the data structure after that introduce
intentional crashes. This is leading to situations when converting from
an older data structure to the new typesafe where, on shutdown, the older
data structures would still be attempted to be accessed. This access would
just be ignored or result in benign code running. With the new typesafe
data structure crashes will occurr. Be aware that when modifying the code
base that this sort of change might end up with crashes on shutdown and
work must be done to ensure that the newly changed does not use the data
structure after the fini call.
FRR lists
---------