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

Fix typos and formatting issues in config framework docs

Browse source
This commit is contained in:
Daniel Thayer 2018-07-30 14:12:25 -05:00
parent 2502e48a01
commit 0e2dbfe7c3
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
scripts/base/frameworks/config/input.bro
View file

@ -60,8 +60,8 @@ event InputConfig::new_value(name: string, source: string, id: string, value: an
function read_config(filename: string) function read_config(filename: string)
{ {
# Only read the configuration on the manager. The other nodes are being fed from # Only read the configuration on the manager. The other nodes are being fed
# the manager. # from the manager.
if ( Cluster::is_enabled() && Cluster::local_node_type() != Cluster::MANAGER ) if ( Cluster::is_enabled() && Cluster::local_node_type() != Cluster::MANAGER )
return; return;

14
scripts/base/frameworks/config/main.bro
View file

@ -28,15 +28,15 @@ export {
## record as it is sent on to the logging framework. ## record as it is sent on to the logging framework.
global log_config: event(rec: Info); global log_config: event(rec: Info);
## Broker topic for announcing new configuration value. Sending new_value, ## Broker topic for announcing new configuration values. Sending new_value,
## peers can send configuration changes that will be distributed accross ## peers can send configuration changes that will be distributed across
## the entire cluster. ## the entire cluster.
const change_topic = "bro/config/change"; const change_topic = "bro/config/change";
## This function is the config framework layer around the lower-level ## This function is the config framework layer around the lower-level
## :bro:see:`Option::set` call. Config::set_value will set the configuration ## :bro:see:`Option::set` call. Config::set_value will set the configuration
## value for all nodes in the cluster, no matter where it was called. Note ## value for all nodes in the cluster, no matter where it was called. Note
## that `bro:see:`Option::set` does not distribute configuration changes ## that :bro:see:`Option::set` does not distribute configuration changes
## to other nodes. ## to other nodes.
## ##
## ID: The ID of the option to update. ## ID: The ID of the option to update.
@ -45,7 +45,7 @@ export {
## ##
## location: Optional parameter detailing where this change originated from. ## location: Optional parameter detailing where this change originated from.
## ##
## Returns: true on success, false when an error ocured. ## Returns: true on success, false when an error occurs.
global set_value: function(ID: string, val: any, location: string &default = "" &optional): bool; global set_value: function(ID: string, val: any, location: string &default = "" &optional): bool;
} }
@ -73,7 +73,7 @@ event Config::cluster_set_option(ID: string, val: any, location: string)
function set_value(ID: string, val: any, location: string &default = "" &optional): bool function set_value(ID: string, val: any, location: string &default = "" &optional): bool
{ {
local cache_val: any; local cache_val: any;
# first cache value in case setting it succeeds and we have to store it. # First cache value in case setting it succeeds and we have to store it.
if ( Cluster::local_node_type() == Cluster::MANAGER ) if ( Cluster::local_node_type() == Cluster::MANAGER )
cache_val = copy(val); cache_val = copy(val);
# First try setting it locally - abort if not possible. # First try setting it locally - abort if not possible.
@ -151,8 +151,8 @@ event bro_init() &priority=10
# Limit logging to the manager - everyone else just feeds off it. # Limit logging to the manager - everyone else just feeds off it.
@if ( !Cluster::is_enabled() || Cluster::local_node_type() == Cluster::MANAGER ) @if ( !Cluster::is_enabled() || Cluster::local_node_type() == Cluster::MANAGER )
# Iterate over all existing options and add ourselves as change handlers with # Iterate over all existing options and add ourselves as change handlers
# a low priority so that we can log the changes. # with a low priority so that we can log the changes.
local gids = global_ids(); local gids = global_ids();
for ( i in gids ) for ( i in gids )
{ {