[Bro-Dev] first try at a skeleton script

Seth Hall seth at icir.org
Mon Oct 18 07:29:53 PDT 2010

On Oct 18, 2010, at 12:36 AM, Robin Sommer wrote:

>> Maybe more general: can we come up with a nice way to document the redef
>> of the various "special purpose" globals that are edited by many
>> scripts? E.g., Notice enums, capture filters, analyzer configurations, etc.
> Good point. For these we need two different types of documentation:
> one defining the purpose of the global, and one which states how a
> script modifies the global when loaded. However, there aren't that
> many of these so we might be fine special-casing them (i.e., just
> listing which notices, filters, etc. a script defines).

I'll rework the skeleton script sometime this week to account for the documentation aimed at script users and at script developers.  Maybe the right way to do it is for me to remove the embedded documentation for the script developers and move all of that documentation into a separate document.  The skeleton script will only contain what the script developer would write.


More information about the bro-dev mailing list