Commit graph

27 commits

Author SHA1 Message Date
Robin Sommer
aec77c7cfe Merge remote-tracking branch 'origin/master' into topic/documentation
Conflicts:
	doc/index.rst
	doc/scripts/builtins.rst
	testing/btest/btest.cfg
2013-08-12 14:03:49 -07:00
Robin Sommer
d3d14e10cf Merge remote-tracking branch 'origin/topic/jsiwek/983'
Closes #983.

* origin/topic/jsiwek/983:
  Add named constructor examples to docs.
  Allow named vector constructors. Addresses #983.
  Allow named table constructors.  Addresses #983.
  Improve set constructor argument coercion.
  Allow named set constructors. Addresses #983.
  Allow named record constructors. Addresses #983.
2013-06-02 17:41:33 -07:00
Jon Siwek
4301002f1a Add named constructor examples to docs. 2013-05-30 11:41:22 -05:00
Jon Siwek
e45933562e Fix broken/missing documentation. 2013-05-23 16:53:42 -05:00
Jon Siwek
e2a1d4a233 Allow default function/hook/event parameters. Addresses #972.
And changed the endianness parameter of bytestring_to_count() BIF to
default to false (big endian), mostly just to prove that the BIF parser
doesn't choke on default parameters.
2013-05-07 14:32:22 -05:00
Daniel Thayer
1c0905914c Document undocumented attributes 2012-12-20 15:25:29 -06:00
Daniel Thayer
75f32093ab Merge remote-tracking branch 'origin/master' into topic/dnthayer/lang-docs 2012-12-20 14:06:36 -06:00
Daniel Thayer
cb7fd7c87c Remove unused attributes
Removed attributes &postprocessor and &match from documentation
and source code.  Removed undocumented attribute &attr from
source code.  Removed internal attribute (&tracked) from documentation.
2012-12-10 15:43:13 -06:00
Daniel Thayer
8c73e83c55 More updates to built-in types document 2012-12-05 17:34:31 -06:00
Daniel Thayer
0fe7c4cf9d Merge remote-tracking branch 'origin/master' into topic/dnthayer/lang-docs 2012-12-04 17:21:32 -06:00
Daniel Thayer
2dc2076b44 Improve description of built-in types
Added more information on operators and literals.
2012-12-04 17:15:05 -06:00
Jon Siwek
4e85fe0454 Change hook calls to only be allowed when preceded by "hook" keyword. 2012-11-30 15:39:00 -06:00
Jon Siwek
3b3b05fbbb Clarification in hook documentation. 2012-11-29 10:07:38 -06:00
Jon Siwek
378ee699ff Hook functions now directly callable instead of w/ "hook" statements.
The return value of the call is an implicit boolean value of T if all
hook handlers ran, or F if one hook handler exited as a result of a
break statement and potentially prevented other handlers from running.

Scripts don't need to declare hooks with an explicit return type of bool
(internally, that's assumed), and any values given to (optional) return
statements in handler definitions are just ignored.

Addresses #918.
2012-11-26 17:09:29 -06:00
Jon Siwek
e0fb9eb2b2 Add new function flavor called a "hook".
This new flavor of function behaves like a "synchronous event".
See documentation for more details on usage.
2012-11-15 13:45:13 -06:00
Daniel Thayer
254715eaaa Remove deprecated attribute &disable_print_hook 2012-09-26 16:47:51 -05:00
Daniel Thayer
c1c9c9e34a Update documentation for builtin types
Add missing description of interval "msec" unit.
Improved description of pattern by clarifying the issue of operand
order and difference between exact and embedded matching.
2012-08-23 13:04:18 -05:00
Robin Sommer
3605dfceeb Merge remote-tracking branch 'origin/fastpath'
* origin/fastpath:
  Fix table expiry for values assigned in bro_init() when reading live.
2012-04-09 16:02:10 -07:00
Jon Siwek
fcd8f9b77e Fix table expiry for values assigned in bro_init() when reading live.
Value assigned in bro_init() to a table with &create_expire
weren't expiring when reading traffic from an interface.  It worked
when reading a pcap file, but I added a test case to show it still
working.
2012-04-06 13:24:27 -05:00
Jon Siwek
94864da465 Update documentation for new syntax of IPv6 literals. 2012-03-14 15:25:08 -05:00
Robin Sommer
7458ebf385 Checkpoint after pass. 2012-02-15 13:07:08 -08:00
Daniel Thayer
3ff0eed3fc Remove mention of --enable-brov6 in docs 2012-02-08 17:30:54 -06:00
Jon Siwek
cc1459ef35 Fix some malformed Broxygen xref roles. 2011-12-16 14:30:36 -06:00
Jon Siwek
1f57827e54 Add more logging framework documentation. 2011-12-09 14:30:21 -06:00
Jon Siwek
6d3b29b0ec Add builtin type documentation, clean up format of attribute docs. 2011-12-08 15:55:38 -06:00
Matthias Vallentin
30399d86e9 Document some attributes.
I am not going to edit the attributes any further, please go ahead and text to
the missing TODOs.
2011-12-01 20:42:05 -08:00
Jon Siwek
fdf01a1ba6 Finished dissolving the sphinx source directory into doc/ and doc/scripts/ 2011-11-15 11:52:52 -06:00
Renamed from doc/source/builtins.rst (Browse further)