Re: [Bro-Dev] Documenting Weirds

2014-07-01 Thread Robin Sommer
On Sat, Jun 28, 2014 at 11:46 -0400, you wrote: Maybe more generally, we should to make a Weird closer to a Notice. For example, if a file analyzer generates a weird, there are no fields in the weird.log to map it back to the offending file. Yeah, that would make a lot sense. I realize

Re: [Bro-Dev] Documenting Weirds

2014-06-28 Thread Vlad Grigorescu
I was thinking of just a simple Weird::Type enum with comments, much like how the Notice documentation is generated. I do also like the thought of the structured namespace. Maybe more generally, we should to make a Weird closer to a Notice. For example, if a file analyzer generates a weird, there

[Bro-Dev] Documenting Weirds

2014-06-27 Thread Vlad Grigorescu
It seems like one area where our documentation is sorely lacking is the weirds. Apart from comments in the code, I believe the only documentation is the name of the weird itself. Is there a mechanism in Broxygen to document weirds? If not, has anyone thought about what such a mechanism might look

Re: [Bro-Dev] Documenting Weirds

2014-06-27 Thread Siwek, Jon
On Jun 27, 2014, at 3:35 PM, Vlad Grigorescu v...@grigorescu.org wrote: Is there a mechanism in Broxygen to document weirds? If not, has anyone thought about what such a mechanism might look like? There’s not currently a mechanism. Things that Broxygen can easily aid in documenting are

Re: [Bro-Dev] Documenting Weirds

2014-06-27 Thread Robin Sommer
On Fri, Jun 27, 2014 at 21:41 +, you wrote: A suggestion would be to change weirds to use an enum instead of a string value. Yeah, either that, or introducing a structured ID namespace (e.g., http.client.unexpected_data), potentially with some static analysis to find IDs that aren't