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

Improve deprecation warning messages

Browse source
This commit is contained in:
Jon Siwek 2019-06-27 18:36:27 -07:00
parent 0edc7c6cbb
commit 7d2d63551d
4 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/Val.h
View file

@ -86,7 +86,7 @@ typedef union {
class Val : public BroObj { class Val : public BroObj {
public: public:
ZEEK_DEPRECATED("use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead")
Val(bool b, TypeTag t) Val(bool b, TypeTag t)
{ {
val.int_val = b; val.int_val = b;
@ -96,7 +96,7 @@ public:
#endif #endif
} }
ZEEK_DEPRECATED("use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead")
Val(int32 i, TypeTag t) Val(int32 i, TypeTag t)
{ {
val.int_val = bro_int_t(i); val.int_val = bro_int_t(i);
@ -106,7 +106,7 @@ public:
#endif #endif
} }
ZEEK_DEPRECATED("use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead")
Val(uint32 u, TypeTag t) Val(uint32 u, TypeTag t)
{ {
val.uint_val = bro_uint_t(u); val.uint_val = bro_uint_t(u);
@ -116,7 +116,7 @@ public:
#endif #endif
} }
ZEEK_DEPRECATED("use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead")
Val(int64 i, TypeTag t) Val(int64 i, TypeTag t)
{ {
val.int_val = i; val.int_val = i;
@ -126,7 +126,7 @@ public:
#endif #endif
} }
ZEEK_DEPRECATED("use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetBool, GetFalse/GetTrue, GetInt, or GetCount instead")
Val(uint64 u, TypeTag t) Val(uint64 u, TypeTag t)
{ {
val.uint_val = u; val.uint_val = u;
@ -429,15 +429,15 @@ protected:
class PortManager { class PortManager {
public: public:
// Port number given in host order. // Port number given in host order.
ZEEK_DEPRECATED("use val_mgr->GetPort() instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetPort() instead")
PortVal* Get(uint32 port_num, TransportProto port_type) const; PortVal* Get(uint32 port_num, TransportProto port_type) const;
// Host-order port number already masked with port space protocol mask. // Host-order port number already masked with port space protocol mask.
ZEEK_DEPRECATED("use val_mgr->GetPort() instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetPort() instead")
PortVal* Get(uint32 port_num) const; PortVal* Get(uint32 port_num) const;
// Returns a masked port number // Returns a masked port number
ZEEK_DEPRECATED("use PortVal::Mask() instead") ZEEK_DEPRECATED("Remove in v3.1: use PortVal::Mask() instead")
uint32 Mask(uint32 port_num, TransportProto port_type) const; uint32 Mask(uint32 port_num, TransportProto port_type) const;
}; };
@ -519,11 +519,11 @@ protected:
class PortVal : public Val { class PortVal : public Val {
public: public:
// Port number given in host order. // Port number given in host order.
ZEEK_DEPRECATED("use val_mgr->GetPort() instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetPort() instead")
PortVal(uint32 p, TransportProto port_type); PortVal(uint32 p, TransportProto port_type);
// Host-order port number already masked with port space protocol mask. // Host-order port number already masked with port space protocol mask.
ZEEK_DEPRECATED("use val_mgr->GetPort() instead") ZEEK_DEPRECATED("Remove in v3.1: use val_mgr->GetPort() instead")
explicit PortVal(uint32 p); explicit PortVal(uint32 p);
Val* SizeVal() const override { return val_mgr->GetInt(val.uint_val); } Val* SizeVal() const override { return val_mgr->GetInt(val.uint_val); }
@ -990,7 +990,7 @@ protected:
class EnumVal : public Val { class EnumVal : public Val {
public: public:
ZEEK_DEPRECATED("use t->GetVal(i) instead") ZEEK_DEPRECATED("Remove in v3.1: use t->GetVal(i) instead")
EnumVal(int i, EnumType* t) : Val(t) EnumVal(int i, EnumType* t) : Val(t)
{ {
val.int_val = i; val.int_val = i;

6
src/event.bif
View file

@ -49,7 +49,7 @@
event zeek_init%(%); event zeek_init%(%);
## Deprecated synonym for :zeek:see:`zeek_init`. ## Deprecated synonym for :zeek:see:`zeek_init`.
event bro_init%(%) &deprecated; event bro_init%(%) &deprecated="Remove in v3.1: use zeek_init";
## Generated at Zeek termination time. The event engine generates this event when ## Generated at Zeek termination time. The event engine generates this event when
## Zeek is about to terminate, either due to having exhausted reading its input ## Zeek is about to terminate, either due to having exhausted reading its input
@ -65,7 +65,7 @@ event bro_init%(%) &deprecated;
event zeek_done%(%); event zeek_done%(%);
## Deprecated synonym for :zeek:see:`zeek_done`. ## Deprecated synonym for :zeek:see:`zeek_done`.
event bro_done%(%) &deprecated; event bro_done%(%) &deprecated="Remove in v3.1: use zeek_done";
## Generated for every new connection. This event is raised with the first ## Generated for every new connection. This event is raised with the first
## packet of a previously unknown connection. Zeek uses a flow-based definition ## packet of a previously unknown connection. Zeek uses a flow-based definition
@ -608,7 +608,7 @@ event reporter_error%(t: time, msg: string, location: string%) &error_handler;
event zeek_script_loaded%(path: string, level: count%); event zeek_script_loaded%(path: string, level: count%);
## Deprecated synonym for :zeek:see:`zeek_script_loaded`. ## Deprecated synonym for :zeek:see:`zeek_script_loaded`.
event bro_script_loaded%(path: string, level: count%) &deprecated; event bro_script_loaded%(path: string, level: count%) &deprecated="Remove in v3.1: use zeek_script_loaded";
## Generated each time Zeek's script interpreter opens a file. This event is ## Generated each time Zeek's script interpreter opens a file. This event is
## triggered only for files opened via :zeek:id:`open`, and in particular not for ## triggered only for files opened via :zeek:id:`open`, and in particular not for

2
src/strings.bif
View file

@ -1034,7 +1034,7 @@ function safe_shell_quote%(source: string%): string
## Returns: A shell-escaped version of *source*. ## Returns: A shell-escaped version of *source*.
## ##
## .. zeek:see:: system safe_shell_quote ## .. zeek:see:: system safe_shell_quote
function str_shell_escape%(source: string%): string &deprecated function str_shell_escape%(source: string%): string &deprecated="Remove in v3.1: use safe_shell_quote"
%{ %{
unsigned j = 0; unsigned j = 0;
const u_char* src = source->Bytes(); const u_char* src = source->Bytes();

4
src/zeek.bif
View file

@ -1810,7 +1810,7 @@ extern const char* zeek_version();
## :zeek:see:`zeek_version` instead. ## :zeek:see:`zeek_version` instead.
## ##
## Returns: Zeek's version, e.g., 2.0-beta-47-debug. ## Returns: Zeek's version, e.g., 2.0-beta-47-debug.
function bro_version%(%): string &deprecated function bro_version%(%): string &deprecated="Remove in v3.1: use zeek_version"
%{ %{
return new StringVal(zeek_version()); return new StringVal(zeek_version());
%} %}
@ -2137,7 +2137,7 @@ function dump_rule_stats%(f: file%): bool
## Returns: True if Zeek is in the process of shutting down. ## Returns: True if Zeek is in the process of shutting down.
## ##
## .. zeek:see:: terminate ## .. zeek:see:: terminate
function bro_is_terminating%(%): bool &deprecated function bro_is_terminating%(%): bool &deprecated="Remove in v3.1: use zeek_is_terminating"
%{ %{
return val_mgr->GetBool(terminating); return val_mgr->GetBool(terminating);
%} %}