Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 14:48:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add note to stub files used for grouping script docs.

Browse source
This commit is contained in:
Jon Siwek 2011-05-12 15:13:51 -05:00
parent 3fe92fc1ff
commit f70b5ece8c
5 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/scripts/CMakeLists.txt
View file

@ -129,6 +129,7 @@ endmacro(REST_TARGET)
# Schedule Bro scripts for which to generate documentation. # Schedule Bro scripts for which to generate documentation.
# Note: the script may be located in a subdirectory off of one of the main # Note: the script may be located in a subdirectory off of one of the main
# directories in BROPATH. In that case, just list the script as 'foo/bar.bro' # directories in BROPATH. In that case, just list the script as 'foo/bar.bro'
rest_target(${CMAKE_CURRENT_SOURCE_DIR} example.bro internal)
rest_target(${POLICY_SRC_DIR} conn.bro user) rest_target(${POLICY_SRC_DIR} conn.bro user)
rest_target(${POLICY_SRC_DIR} site.bro user) rest_target(${POLICY_SRC_DIR} site.bro user)
rest_target(${POLICY_SRC_DIR} dns.bro policy/dns-index) rest_target(${POLICY_SRC_DIR} dns.bro policy/dns-index)
@ -137,7 +138,6 @@ rest_target(${POLICY_SRC_DIR} dns/base.bro policy/dns-index)
rest_target(${POLICY_SRC_DIR} dns/consts.bro policy/dns-index) rest_target(${POLICY_SRC_DIR} dns/consts.bro policy/dns-index)
rest_target(${POLICY_SRC_DIR} dns/detect.bro policy/dns-index) rest_target(${POLICY_SRC_DIR} dns/detect.bro policy/dns-index)
rest_target(${POLICY_SRC_DIR} dns/passive-replication.bro policy/dns-index) rest_target(${POLICY_SRC_DIR} dns/passive-replication.bro policy/dns-index)
rest_target(${CMAKE_CURRENT_SOURCE_DIR} example.bro internal)
# Finding out what scripts bro will generate documentation for by default # Finding out what scripts bro will generate documentation for by default
# can be done like: `bro --doc-scripts --exec ""` # can be done like: `bro --doc-scripts --exec ""`

3
doc/scripts/source/bifs.rst
View file

@ -1,4 +1,5 @@
.. This is a stub doc to which the build process can append.
Built-In Functions (BIFs) Built-In Functions (BIFs)
========================= =========================
Here's a list of all documentation for BIFs that Bro provides:

2
doc/scripts/source/internal.rst
View file

@ -1,3 +1,5 @@
.. This is a stub doc to which the build process can append.
Internal Policy Scripts Internal Policy Scripts
======================= =======================

2
doc/scripts/source/policy/dns-index.rst
View file

@ -1,3 +1,5 @@
.. This is a stub doc to which the build process can append.
DNS Policy Scripts DNS Policy Scripts
================== ==================

2
doc/scripts/source/user.rst
View file

@ -1,3 +1,5 @@
.. This is a stub doc to which the build process can append.
Other User-Facing Policy Scripts Other User-Facing Policy Scripts
================================ ================================