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

BIT-1635: fix make doc warnings

Browse source 
References to Input::Reader and Log::Writer enum types no longer emit
warnings as they are now hardcoded to be documented as part of their
associated framework scripts and so links to them now work.
This commit is contained in:
Jon Siwek 2018-06-01 10:03:24 -05:00
parent b2dc7ffb26
commit f9e5777e6f
4 changed files with 24 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CHANGES
View file

@ -1,4 +1,14 @@
2.5-618 | 2018-06-01 10:03:24 -0500
* BIT-1635: fix `make doc` warnings (Corelight)
* Add smb2_file_sattr event (Devin Trejo)
* Add bad ARP tests (Pierre LATET)
* Fix SCT validation when invalid certificates are in chain. (Johanna Amann)
2.5-611 | 2018-05-29 10:13:17 -0500 2.5-611 | 2018-05-29 10:13:17 -0500
* Fix NEWS file formatting (Corelight) * Fix NEWS file formatting (Corelight)

2
VERSION
View file

@ -1 +1 @@
2.5-611 2.5-618

2
doc/conf.py.in
View file

@ -195,8 +195,6 @@ html_sidebars = {
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'Broxygen' htmlhelp_basename = 'Broxygen'
html_add_permalinks = None
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4'). # The paper size ('letter' or 'a4').

13
src/broxygen/ScriptInfo.cc
View file

@ -250,6 +250,19 @@ void ScriptInfo::DoInitPostScript()
id->Name(), name.c_str()); id->Name(), name.c_str());
state_vars.push_back(info); state_vars.push_back(info);
} }
// The following enum types are automatically created internally in Bro,
// so just manually associating them with scripts for now.
if ( name == "base/frameworks/input/main.bro" )
{
auto id = global_scope()->Lookup("Input::Reader");
types.push_back(new IdentifierInfo(id, this));
}
else if ( name == "base/frameworks/logging/main.bro" )
{
auto id = global_scope()->Lookup("Log::Writer");
types.push_back(new IdentifierInfo(id, this));
}
} }
vector<string> ScriptInfo::GetComments() const vector<string> ScriptInfo::GetComments() const