Merge remote-tracking branch 'origin/fastpath'

* origin/fastpath:
  Fix typos in the broker BIF documentation
  update installation instructions and remove outdated references.

CHANGES

@@ -1,4 +1,14 @@
 
+2.3-892 | 2015-04-27 08:22:22 -0700
+
+  * Fix typos in the Broker BIF documentation. (Daniel Thayer)
+
+  * Update installation instructions and remove outdated references.
+    (Johanna Amann)
+
+  * Easier support for systems with tcmalloc_minimal installed. (Seth
+    Hall)
+
 2.3-884 | 2015-04-23 12:30:15 -0500
 
   * Fix some outdated documentation unit tests. (Jon Siwek)

VERSION

@@ -1 +1 @@
-2.3-884
+2.3-892

doc/install/install.rst

@@ -68,7 +68,7 @@ that ``bash`` and ``python`` are in your ``PATH``):
 
   .. console::
 
-      sudo pkg_add -r bash cmake swig bison python perl
+      sudo pkg_add -r bash cmake swig bison python perl py27-sqlite3
 
 * Mac OS X:
 
@@ -113,19 +113,15 @@ Using Pre-Built Binary Release Packages
 =======================================
 
 See the `bro downloads page`_ for currently supported/targeted
-platforms for binary releases.
+platforms for binary releases and for installation instructions.
 
-* RPM
+* Linux Packages
 
-  .. console::
-
-      sudo yum localinstall Bro-*.rpm
-
-* DEB
-
-  .. console::
-
-      sudo gdebi Bro-*.deb
+  Linux based binary installations are usually performed by adding
+  information about the Bro packages to the respective system packaging
+  tool. Theen the usual system utilities such as ``apt``, ``yum``
+  or ``zyppper`` are used to perforn the installation. By default,
+  installations of binary packages will go into ``/opt/bro``.
 
 * MacOS Disk Image with Installer
 
@@ -133,8 +129,6 @@ platforms for binary releases.
   Everything installed by the package will go into ``/opt/bro``.
 
 The primary install prefix for binary packages is ``/opt/bro``.
-Non-MacOS packages that include BroControl also put variable/runtime
-data (e.g. Bro logs) in ``/var/opt/bro``.
 
 Installing from Source
 ==========================

src/broker/comm.bif

@@ -1,5 +1,5 @@
 
-##! General functions regarding Bro's broker communication mechanisms.
+##! Functions and events regarding Bro's broker communication mechanisms.
 
 %%{
 #include "broker/Manager.h"
@@ -23,7 +23,7 @@ function BrokerComm::enable%(flags: EndpointFlags &default = EndpointFlags()%):
 ##
 ## flags: the new endpoint behavior flags to use.
 ##
-## Returns: true of flags were changed.
+## Returns: true if flags were changed.
 function BrokerComm::set_endpoint_flags%(flags: EndpointFlags &default = EndpointFlags()%): bool
 	%{
 	return new Val(broker_mgr->SetEndpointFlags(flags), TYPE_BOOL);
@@ -162,7 +162,7 @@ function BrokerComm::listen%(p: port, a: string &default = "",
 ##
 ## Returns: true if it's possible to try connecting with the peer and
 ##          it's a new peer.  The actual connection may not be established
-##          a later point in time.
+##          until a later point in time.
 ##
 ## .. bro:see:: BrokerComm::outgoing_connection_established
 function BrokerComm::connect%(a: string, p: port, retry: interval%): bool

src/broker/data.bif

@@ -7,8 +7,8 @@
 
 module BrokerComm;
 
-## Enumerates the possible types that :bro:see:`BrokerComm::Data` may be in terms of
-## Bro data types.
+## Enumerates the possible types that :bro:see:`BrokerComm::Data` may be in
+## terms of Bro data types.
 enum DataType %{
 	BOOL,
 	INT,
@@ -31,13 +31,14 @@ type BrokerComm::Data: record;
 
 type BrokerComm::TableItem: record;
 
-## Convert any Bro value in to communication data.
+## Convert any Bro value to communication data.
 ##
 ## d: any Bro value to attempt to convert (not all types are supported).
 ##
-## Returns: the converted communication data which may not set its only
-##          opaque field of the the conversion was not possible (the Bro data
-##          type does not support being converted to communicaiton data).
+## Returns: the converted communication data.  The returned record's optional
+##          field will not be set if the conversion was not possible (this can
+##          happen if the Bro data type does not support being converted to
+##          communication data).
 function BrokerComm::data%(d: any%): BrokerComm::Data
 	%{
 	return bro_broker::make_data_val(d);
@@ -237,7 +238,7 @@ function BrokerComm::set_contains%(s: BrokerComm::Data, key: BrokerComm::Data%):
 	return new Val(v.find(k) != v.end(), TYPE_BOOL);
 	%}
 
-### Insert an element into a set.
+## Insert an element into a set.
 ##
 ## s: the set to modify.
 ##
@@ -367,7 +368,7 @@ function BrokerComm::table_size%(t: BrokerComm::Data%): count
 ##
 ## key: the key to check for existence.
 ##
-## Returns: true if the key exists in the set.
+## Returns: true if the key exists in the table.
 function BrokerComm::table_contains%(t: BrokerComm::Data, key: BrokerComm::Data%): bool
 	%{
 	auto& v = bro_broker::require_data_type<broker::table>(t->AsRecordVal(),
@@ -724,7 +725,7 @@ function BrokerComm::record_size%(r: BrokerComm::Data%): count
 
 ## Replace a field in a record at a particular position.
 ##
-## t: the table to modify.
+## r: the record to modify.
 ##
 ## d: the new field value to assign.
 ##
@@ -752,7 +753,7 @@ function BrokerComm::record_assign%(r: BrokerComm::Data, d: BrokerComm::Data, id
 ##
 ## Returns: the value at the index.  The optional field of the returned record
 ##          may not be set if the field of the record has no value or if the
-##          the index was not valid.
+##          index was not valid.
 function BrokerComm::record_lookup%(r: BrokerComm::Data, idx: count%): BrokerComm::Data
 	%{
 	auto& v = bro_broker::require_data_type<broker::record>(r->AsRecordVal(),

src/broker/messaging.bif

@@ -35,7 +35,7 @@ function BrokerComm::print%(topic: string, msg: string,
 	%}
 
 ## Register interest in all peer print messages that use a certain topic prefix.
-## use :bro:see:`BrokerComm::print_handler` to handle received messages.
+## Use :bro:see:`BrokerComm::print_handler` to handle received messages.
 ##
 ## topic_prefix: a prefix to match against remote message topics.
 ##               e.g. an empty prefix matches everything and "a" matches
@@ -99,7 +99,7 @@ function BrokerComm::event%(topic: string, args: BrokerComm::EventArgs,
 ##
 ## ev: a Bro event value.
 ##
-## flags: tune the behavior of how the message is send.
+## flags: tune the behavior of how the message is sent.
 ##
 ## Returns: true if automatic event sending is now enabled.
 function BrokerComm::auto_event%(topic: string, ev: any,
@@ -115,7 +115,7 @@ function BrokerComm::auto_event%(topic: string, ev: any,
 ##
 ## ev: an event originally given to :bro:see:`BrokerComm::auto_event`.
 ##
-## Returns: true if automatic events will no occur for the topic/event pair.
+## Returns: true if automatic events will not occur for the topic/event pair.
 function BrokerComm::auto_event_stop%(topic: string, ev: any%): bool
 	%{
 	auto rval = broker_mgr->AutoEventStop(topic->CheckString(), ev);
@@ -174,6 +174,10 @@ function BrokerComm::disable_remote_logs%(id: Log::ID%): bool
 	return new Val(rval, TYPE_BOOL);
 	%}
 
+## Check if remote logs are enabled for a given log stream.
+##
+## id: the log stream to check.
+##
 ## Returns: true if remote logs are enabled for the given stream.
 function BrokerComm::remote_logs_enabled%(id: Log::ID%): bool
 	%{

src/broker/store.bif

@@ -326,10 +326,10 @@ function BrokerStore::remove_from_set%(h: opaque of BrokerStore::Handle,
 ##
 ## k: the key whose associated value is to be modified.
 ##
-## item: the element to insert in to the vector.  A non-existent key will first
-##       create empty vector value before modifying.
+## items: the element to insert in to the vector.  A non-existent key will first
+##        create an empty vector value before modifying.
 ##
-## Returns: the handle of store to modify.
+## Returns: false if the store handle was not valid.
 function BrokerStore::push_left%(h: opaque of BrokerStore::Handle, k: BrokerComm::Data,
                            items: BrokerComm::DataVector%): bool
 	%{
@@ -359,10 +359,10 @@ function BrokerStore::push_left%(h: opaque of BrokerStore::Handle, k: BrokerComm
 ##
 ## k: the key whose associated value is to be modified.
 ##
-## item: the element to insert in to the vector.  A non-existent key will first
-##       create empty vector value before modifying.
+## items: the element to insert in to the vector.  A non-existent key will first
+##        create an empty vector value before modifying.
 ##
-## Returns: the handle of store to modify.
+## Returns: false if the store handle was not valid.
 function BrokerStore::push_right%(h: opaque of BrokerStore::Handle, k: BrokerComm::Data,
                             items: BrokerComm::DataVector%): bool
 	%{