Bugzilla – Bug 444
Inernet-stack trace sources not well documented
Last modified: 2008-12-13 17:15:51 EST
We have lots of trace sources lying around in the internet stack, but they are not very well documented. There needs to be an easily found documentation piece that tells users what these sources are actaully tracing.
I suggest a model description in the same spirit as the csma device model (csma.h) in doxygen.
(In reply to comment #0)
> We have lots of trace sources lying around in the internet stack, but they are
> not very well documented. There needs to be an easily found documentation
> piece that tells users what these sources are actaully tracing.
> I suggest a model description in the same spirit as the csma device model
> (csma.h) in doxygen.
I have similar comments as to 442.
We have an introspection system for trace sources:
This should be clear, or made more clear if deficient. This should be the primary documentation of "what these sources are actually tracing".
Then, there could be two additional pieces of documentation:
1) some way to tell users that this collection of trace sources belongs to something called an InternetStack, and how they relate to one another. This could be internet-stack.h, similar to csma.h, and reachable from the "Modules" tab.
2) what the helpers do, when tracing is enabled at the helper API level.
We have agreed on a three-level solution to this bug
Level 1) Help strings are to be made more descriptive so they make sense in the list of all trace sources.
Level 2) Create an internet-stack model description in the spirit of the device models (cf csma.h) in which we address HASA trace source relationships and describe when trace hooks are hit.
Level 3) In the manual, there will be a new section added that will allow very detailed explanations.