Fixes for script auto-documentation.

- Fixing the parts of the `make restdoc` and `make doc` process that were
  broken by the last Bro script re-organization

- Generated documentation for Bro scripts derived from BiFs now use the
  original BiF source file as the "original source file" link

- Renaming of the internal POLICYDEST definition and other misc places that
  refer to "policy" scripts; that terminology doesn't make total sense now

- Added a documentation blacklist reminder test that will fail if there's
  scripts that are blacklisted from being documentated because they're still
  in progress

- Some minor Bro script changes to fix small @load dependency errors

Addresses #543
This commit is contained in:
Jon Siwek 2011-08-08 19:50:45 -05:00
parent 0e2a1605b3
commit 4ac6d0ae2e
40 changed files with 178 additions and 154 deletions

View file

@ -1,9 +1,8 @@
include(InstallPackageConfigFile)
install(DIRECTORY ./ DESTINATION ${POLICYDIR} FILES_MATCHING
install(DIRECTORY ./ DESTINATION ${BRO_SCRIPT_INSTALL_PATH} FILES_MATCHING
PATTERN "all.bro" EXCLUDE
PATTERN "site/local.bro" EXCLUDE
PATTERN "bro.init"
PATTERN "*.bro"
PATTERN "*.sig"
PATTERN "*.osf"
@ -13,6 +12,6 @@ install(DIRECTORY ./ DESTINATION ${POLICYDIR} FILES_MATCHING
# user modify-able.
InstallPackageConfigFile(
${CMAKE_CURRENT_SOURCE_DIR}/site/local.bro
${POLICYDIR}/site
${BRO_SCRIPT_INSTALL_PATH}/site
local.bro)

View file

@ -1,3 +1,5 @@
@load base/frameworks/communication
module Cluster;
event bro_init() &priority=9

View file

@ -2,4 +2,4 @@
# TODO: get rid of this as soon as the Expr.cc hack is changed.
@if ( getenv("ENABLE_COMMUNICATION") != "" )
@load ./main
@endif
@endif

View file

@ -1,4 +1,4 @@
@load frameworks/metrics
@load base/frameworks/metrics
redef enum Metrics::ID += {
CONNS_ORIGINATED,
@ -16,4 +16,4 @@ event connection_established(c: connection)
Metrics::add_data(CONNS_ORIGINATED, [$host=c$id$orig_h], 1);
Metrics::add_data(CONNS_RESPONDED, [$host=c$id$resp_h], 1);
}

View file

@ -1,4 +1,4 @@
@load frameworks/metrics
@load base/frameworks/metrics
redef enum Metrics::ID += {
HTTP_REQUESTS_BY_STATUS_CODE,
@ -17,4 +17,4 @@ event HTTP::log_http(rec: HTTP::Info)
Metrics::add_data(HTTP_REQUESTS_BY_HOST, [$index=rec$host], 1);
if ( rec?$status_code )
Metrics::add_data(HTTP_REQUESTS_BY_STATUS_CODE, [$host=rec$id$orig_h, $index=fmt("%d", rec$status_code)], 1);
}
}

View file

@ -1,4 +1,3 @@
module Notice;
export {
@ -25,4 +24,4 @@ event notice(n: Notice::Info) &priority=-5
if ( email != "" )
email_notice_to(n, email, T);
}
}
}

View file

@ -8,7 +8,7 @@ event Notice::notice(n: Notice::Info) &priority=10
return;
# This should only be done for notices that are being sent to email.
if ( ACTION_EMAIL !in n$action )
if ( ACTION_EMAIL !in n$actions )
return;
local output = "";
@ -37,4 +37,4 @@ event Notice::notice(n: Notice::Info) &priority=10
if ( output != "" )
n$email_body_sections[|n$email_body_sections|] = output;
}
}

View file

@ -1,4 +1,3 @@
module Weird;
export {

View file

@ -1,7 +1,7 @@
##! The mime script does analysis of MIME encoded messages seen in certain
##! protocols (only SMTP and POP3 at the moment).
@load utils/strings
@load base/utils/strings
module MIME;

View file

@ -1,5 +1,5 @@
@load protocols/mime/file-ident
@load utils/files
@load ./file-ident
@load base/utils/files
module MIME;
@ -57,4 +57,4 @@ event mime_end_entity(c: connection) &priority=-3
if ( c$mime?$extraction_file )
close(c$mime$extraction_file);
}

View file

@ -1,4 +1,4 @@
@load protocols/mime/file-ident
@load ./file-ident
module MIME;
@ -75,4 +75,4 @@ event mime_end_entity(c: connection) &priority=-3
NOTICE([$note=MD5, $msg=fmt("Calculated a hash for a MIME entity from %s", c$id$orig_h),
$sub=c$mime$md5, $conn=c]);
}
}
}

View file

@ -1,4 +1,4 @@
@load protocols/mime/base
@load ./base
module MIME;

View file

@ -1,5 +1,7 @@
##! Listen for other Bro instances to make unencrypted connections.
@load base/frameworks/communication
module Communication;
export {

View file

@ -1,5 +1,7 @@
##! Listen for other Bro instances and encrypt the connection with SSL.
@load base/frameworks/communication
module Communication;
export {

View file

@ -1,3 +1,4 @@
@load base/frameworks/communication
module Control;
@ -99,4 +100,4 @@ event remote_connection_handshake_done(p: event_peer) &priority=-10
# Signal configuration update to peer.
event Control::configuration_update_request();
}
}
}

View file

@ -1,4 +1,4 @@
@load frameworks/notice
@load base/frameworks/notice
@load port-name
module Scan;

View file

@ -43,4 +43,4 @@ redef signature_files += "frameworks/signatures/detect-windows-shells.sig";
@load protocols/ssl/known-certs
# Load the script to enable SSL/TLS certificate validation.
@load protocols/ssl/validate-certs
@load protocols/ssl/validate-certs