mirror of
https://github.com/zeek/zeek.git
synced 2025-10-10 10:38:20 +00:00
c0e0481af2
* topic/robin/input-threads-merge: (130 commits) And now it even compiles after my earlier changes. A set of input framework refactoring, cleanup, and polishing. another small memory leak in ascii reader: and another small memory leak when using streaming reads. fix another memory lead (when updating tables). Input framework merge in progress. filters have been called streams for eternity. And I always was too lazy to change it everywhere... reactivate network_time check in threading manager. previously this line made all input framework tests fail - it works now. Some of the other recent changes of the threading manager must have fixed that problem. fix up the executeraw test - now it works for the first time and does not always fail baselines for the autostart removal. remove last remnants of autostart, which has been removed for quite a while. make input framework source (hopefully) adhere to the usual indentation style. No functional changes. fix two memory leaks which occured when one used filters. update description to current interface. rename a couple of structures and make the names in manager fit the api more. fix memory leak in tables and vectors that are read into tables fix missing get call for heart beat in benchmark reader. fix heart_beat_interval -- initialization in constructor does not work anymore (probably due to change in init ordering?) fix memory leak for tables... nearly completely. fix a couple more leaks. But - still leaking quite a lot with tables. ... |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| bin | ||
| components | ||
| ext | ||
| images | ||
| scripts | ||
| .gitignore | ||
| CHANGES | ||
| cluster.rst | ||
| CMakeLists.txt | ||
| conf.py.in | ||
| faq.rst | ||
| geoip.rst | ||
| index.rst | ||
| input.rst | ||
| INSTALL.rst | ||
| logging-dataseries.rst | ||
| logging.rst | ||
| notice.rst | ||
| quickstart.rst | ||
| README | ||
| reporting-problems.rst | ||
| signatures.rst | ||
| upgrade.rst | ||
Documentation ============= This directory contains Bro documentation in reStructuredText format (see http://docutils.sourceforge.net/rst.html). It is the root of a Sphinx source tree and can be modified to add more common/general documentation, style sheets, JavaScript, etc. The Sphinx config file is produced from ``conf.py.in``, and can be edited to change various Sphinx options. There is also a custom Sphinx domain implemented in ``source/ext/bro.py`` which adds some reST directives and roles that aid in generating useful index entries and cross-references. Other extensions can be added in a similar fashion. Either the ``make doc`` or ``make broxygen`` targets in the top-level Makefile can be used to locally render the reST files into HTML. Those targets depend on: * Python interpreter >= 2.5 * `Sphinx <http://sphinx.pocoo.org/>`_ >= 1.0.1 After completion, HTML documentation is symlinked in ``build/html``. There's also ``make docclean`` and ``make broxygenclean`` targets to clean the resulting documentation. Notes for Writing Documentation ------------------------------- * If you want to refer to a document that's part of the distribution, it currently needs to be copied or otherwise symlinked somewhere in to this Sphinx source tree. Then, it can be referenced in a toc tree or with the :doc: role. Use the :download: role to refer to static files that will not undergo sphinx rendering. * If you want to refer to a page on the Bro web site, use an HTTP URL. Guidelines ---------- TODO.