[Bro-Dev] Autodoc: how to link to another script?

[Seth Hall]

On Aug 10, 2011, at 4:40 PM, Gregor Maier wrote:

> (1) and (3) are kinda related. I always found it very hard to know and understand what all the 100's of redef'able consts in bro.init did. I think doing it this way is nice way of putting the documentation together and giving users and easy way to access the functionality (load the tunnel script, look at it's documentation for details)
> 
> We can probably split it up and put (1) in policy/ and (2) in base/. However, (2) only works if the connection_compressor is disabled (otherwise the identity of the tunnel is lost), so this makes it more problematic to put it in base (at least while the connection_compressor remains on by default)

Ah, ok.  That makes sense.  That's probably the right way to do it.  Make it disabled by default (with scripts using it loaded in base) and create a file named policy/protocols/conn/decapsulate-tunnels.bro (or something like that).  In the decapsulate-tunnels.bro script, you could document that it relies on the connection compressor being disabled.  If people don't read the docs for scripts before @load-ing them it's hard to blame the script author. :)

> I've attached the current version. Might be easier to just look at it than explaining it via email ;-)


Cool, thanks.  I'll take a look later.

  .Seth

--
Seth Hall
International Computer Science Institute
(Bro) because everyone has a network
http://www.bro-ids.org/