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-1936: improve Broxygen warnings

Browse source
This commit is contained in:
Jon Siwek 2018-06-05 17:32:47 -05:00
parent b5b688b5f5
commit 0b4871daf4
3 changed files with 29 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CHANGES
View file

@ -1,4 +1,8 @@
2.5-648 | 2018-06-05 17:32:47 -0500
* BIT-1936: improve Broxygen warnings (Corelight)
2.5-647 | 2018-06-05 15:19:16 -0500 2.5-647 | 2018-06-05 15:19:16 -0500
* Update `make doc`: don't copy broker docs (Corelight) * Update `make doc`: don't copy broker docs (Corelight)

2
VERSION
View file

@ -1 +1 @@
2.5-647 2.5-648

35
src/broxygen/Manager.cc
View file

@ -12,7 +12,13 @@ using namespace std;
static void DbgAndWarn(const char* msg) static void DbgAndWarn(const char* msg)
{ {
reporter->InternalWarning("%s", msg); if ( reporter->Errors() )
// We've likely already reported to real source of the problem
// as an error, avoid adding an additional warning which may
// be confusing.
return;
reporter->Warning("%s", msg);
DBG_LOG(DBG_BROXYGEN, "%s", msg); DBG_LOG(DBG_BROXYGEN, "%s", msg);
} }
@ -22,7 +28,8 @@ static void WarnMissingScript(const char* type, const ID* id,
if ( script == "<command line>" ) if ( script == "<command line>" )
return; return;
DbgAndWarn(fmt("Can't document %s %s, lookup of %s failed", DbgAndWarn(fmt("Can't generate Broxygen doumentation for %s %s, "
"lookup of %s failed",
type, id->Name(), script.c_str())); type, id->Name(), script.c_str()));
} }
@ -122,7 +129,8 @@ void Manager::Script(const string& path)
if ( scripts.GetInfo(name) ) if ( scripts.GetInfo(name) )
{ {
DbgAndWarn(fmt("Duplicate script documentation: %s", name.c_str())); DbgAndWarn(fmt("Duplicate Broxygen script documentation: %s",
name.c_str()));
return; return;
} }
@ -138,7 +146,8 @@ void Manager::Script(const string& path)
if ( packages.GetInfo(name) ) if ( packages.GetInfo(name) )
{ {
DbgAndWarn(fmt("Duplicate package documentation: %s", name.c_str())); DbgAndWarn(fmt("Duplicate Broxygen package documentation: %s",
name.c_str()));
return; return;
} }
@ -155,7 +164,8 @@ void Manager::ScriptDependency(const string& path, const string& dep)
if ( dep.empty() ) if ( dep.empty() )
{ {
DbgAndWarn(fmt("Empty script doc dependency: %s", path.c_str())); DbgAndWarn(fmt("Empty Broxygen script doc dependency: %s",
path.c_str()));
return; return;
} }
@ -165,8 +175,8 @@ void Manager::ScriptDependency(const string& path, const string& dep)
if ( ! script_info ) if ( ! script_info )
{ {
DbgAndWarn(fmt("Failed to add script doc dependency %s for %s", DbgAndWarn(fmt("Failed to add Broxygen script doc dependency %s "
depname.c_str(), name.c_str())); "for %s", depname.c_str(), name.c_str()));
return; return;
} }
@ -189,7 +199,7 @@ void Manager::ModuleUsage(const string& path, const string& module)
if ( ! script_info ) if ( ! script_info )
{ {
DbgAndWarn(fmt("Failed to add module usage %s in %s", DbgAndWarn(fmt("Failed to add Broxygen module usage %s in %s",
module.c_str(), name.c_str())); module.c_str(), name.c_str()));
return; return;
} }
@ -231,7 +241,8 @@ void Manager::StartType(ID* id)
if ( id->GetLocationInfo() == &no_location ) if ( id->GetLocationInfo() == &no_location )
{ {
DbgAndWarn(fmt("Can't document %s, no location available", id->Name())); DbgAndWarn(fmt("Can't generate broxygen doumentation for %s, "
"no location available", id->Name()));
return; return;
} }
@ -323,7 +334,8 @@ void Manager::RecordField(const ID* id, const TypeDecl* field,
if ( ! idd ) if ( ! idd )
{ {
DbgAndWarn(fmt("Can't document record field %s, unknown record: %s", DbgAndWarn(fmt("Can't generate broxygen doumentation for "
"record field %s, unknown record: %s",
field->id, id->Name())); field->id, id->Name()));
return; return;
} }
@ -348,7 +360,8 @@ void Manager::Redef(const ID* id, const string& path)
if ( ! id_info ) if ( ! id_info )
{ {
DbgAndWarn(fmt("Can't document redef of %s, identifier lookup failed", DbgAndWarn(fmt("Can't generate broxygen doumentation for "
"redef of %s, identifier lookup failed",
id->Name())); id->Name()));
return; return;
} }