[Bro-Dev] #435: topic/jsiwek/doc-framework

Bro Tracker bro at tracker.icir.org
Mon May 2 14:27:47 PDT 2011


#435: topic/jsiwek/doc-framework
---------------------+------------------------
  Reporter:  jsiwek  |      Owner:  jsiwek
      Type:  Task    |     Status:  assigned
  Priority:  Low     |  Milestone:  Bro1.6
 Component:  Bro     |    Version:  git/master
Resolution:          |   Keywords:
---------------------+------------------------

Comment (by jsiwek):

 This branch now has changes that we've talked about:

 * move `doc/` to `doc/scripts/`
 * delete `.state` dir before/after generating docs for a given script
 * fix `@load`s from subdirectories, e.g. `@load foo/bar` in a way that
 avoid conflicts with `@load baz/bar`
   * I chose to use a directory hierarchy in the Sphinx setup -- which
 should automatically pick up on subdirs that one uses when defining a
 script-to-document in the `CMakeLists.txt`
 * bro parse errors now generate a hint to check `##` comments when in doc
 mode
 * add a btest that tests success of `make restdoc` (generates reST for all
 scripts defined in `CMakeLists.txt`, but doesn't do the Sphinx part)
 * I know we said getting incremental builds wasn't a requirement, but it
 should now work for the `make restdoc` part of it.  The other half of it,
 Sphinx creating HTML from reST, is still not incremental.  From my effort
 so far, it was difficult to figure out the right way to bridge the two
 build systems (CMake and Sphinx).

 I think the new logging stuff is stable enough for me to try to start
 tracking it in the documentation right?  Want me to try to get that
 working in some manner before you merge this branch again?

-- 
Ticket URL: <http://tracker.icir.org/bro/ticket/435#comment:16>
Bro Tracker <http://tracker.icir.org/bro>
Bro Issue Tracker



More information about the bro-dev mailing list