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

Added some grammar and spelling corrections to Installation and Quick Start Guide.

Browse source
This commit is contained in:
Jeannette Dopheide 2014-01-29 11:23:31 -06:00
parent af95026348
commit 4c52c378d5
3 changed files with 20 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

35
doc/install/guidelines.rst
View file

@ -12,32 +12,31 @@ local customizations over. In the following we summarize general
guidelines for upgrading, see the :ref:`release-notes` for guidelines for upgrading, see the :ref:`release-notes` for
version-specific information. version-specific information.
Re-Using Previous Install Prefix Reusing Previous Install Prefix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you choose to configure and install Bro with the same prefix If you choose to configure and install Bro with the same prefix
directory as before, local customization and configuration to files in directory as before, local customization and configuration to files in
``$prefix/share/bro/site`` and ``$prefix/etc`` won't be overwritten ``$prefix/share/bro/site`` and ``$prefix/etc`` won't be overwritten
(``$prefix`` indicating the root of where Bro was installed). Also, logs (``$prefix`` indicating the root of where Bro was installed). Also, logs
generated at run-time won't be touched by the upgrade. (But making generated at run-time won't be touched by the upgrade. Backing up local
a backup of local changes before upgrading is still recommended.) changes before upgrading is still recommended.
After upgrading, remember to check ``$prefix/share/bro/site`` and After upgrading, remember to check ``$prefix/share/bro/site`` and
``$prefix/etc`` for ``.example`` files, which indicate the ``$prefix/etc`` for ``.example`` files, which indicate that the
distribution's version of the file differs from the local one, which may distribution's version of the file differs from the local one, and therefore,
include local changes. Review the differences, and make adjustments may include local changes. Review the differences and make adjustments
as necessary (for differences that aren't the result of a local change, as necessary. Use the new version for differences that aren't a result of
use the new version's). a local change.
Using a New Install prefix Using a New Install Prefix
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to install the newer version in a different prefix To install the newer version in a different prefix directory than before,
directory than before, you can just copy local customization and copy local customization and configuration files from ``$prefix/share/bro/site``
configuration files from ``$prefix/share/bro/site`` and ``$prefix/etc`` and ``$prefix/etc`` to the new location (``$prefix`` indicating the root of
to the new location (``$prefix`` indicating the root of where Bro was where Bro was originally installed). Review the files for differences
originally installed). Make sure to review the files for difference before copying and make adjustments as necessary (use the new version for
before copying and make adjustments as necessary (for differences that differences that aren't a result of a local change). Of particular note,
aren't the result of a local change, use the new version's). Of the copied version of ``$prefix/etc/broctl.cfg`` is likely to need changes
particular note, the copied version of ``$prefix/etc/broctl.cfg`` is to the ``SpoolDir`` and ``LogDir`` settings.
likely to need changes to the ``SpoolDir`` and ``LogDir`` settings.

4
doc/install/install.rst
View file

@ -3,7 +3,7 @@
.. _Xcode: https://developer.apple.com/xcode/ .. _Xcode: https://developer.apple.com/xcode/
.. _MacPorts: http://www.macports.org .. _MacPorts: http://www.macports.org
.. _Fink: http://www.finkproject.org .. _Fink: http://www.finkproject.org
.. _Homebrew: http://mxcl.github.com/homebrew .. _Homebrew: http://brew.sh
.. _bro downloads page: http://bro.org/download/index.html .. _bro downloads page: http://bro.org/download/index.html
.. _installing-bro: .. _installing-bro:
@ -144,7 +144,7 @@ Bro releases are bundled into source packages for convenience and are
available on the `bro downloads page`_. Alternatively, the latest available on the `bro downloads page`_. Alternatively, the latest
Bro development version can be obtained through git repositories Bro development version can be obtained through git repositories
hosted at ``git.bro.org``. See our `git development documentation hosted at ``git.bro.org``. See our `git development documentation
<http://bro.org/development/process.html>`_ for comprehensive <http://bro.org/development/howtos/process.html>`_ for comprehensive
information on Bro's use of git revision control, but the short story information on Bro's use of git revision control, but the short story
for downloading the full source code experience for Bro via git is: for downloading the full source code experience for Bro via git is:

2
doc/quickstart/index.rst
View file

@ -407,7 +407,7 @@ logging) and adds SSL certificate validation.
You might notice that a script you load from the command line uses the You might notice that a script you load from the command line uses the
``@load`` directive in the Bro language to declare dependence on other scripts. ``@load`` directive in the Bro language to declare dependence on other scripts.
This directive is similar to the ``#include`` of C/C++, except the semantics This directive is similar to the ``#include`` of C/C++, except the semantics
are "load this script if it hasn't already been loaded". are, "load this script if it hasn't already been loaded."
.. note:: If one wants Bro to be able to load scripts that live outside the .. note:: If one wants Bro to be able to load scripts that live outside the
default directories in Bro's installation root, the ``BROPATH`` environment default directories in Bro's installation root, the ``BROPATH`` environment