[#2245] Text edits

diff --git a/doc/sphinx/arm/hammer.rst b/doc/sphinx/arm/hammer.rst
index a8b8c8bcef67b26e50b8eea4d43ebcdccb89f524..a8831f381057ad21a5fd177b8ac8e4ebb6e923bc 100644 (file)
--- a/doc/sphinx/arm/hammer.rst
+++ b/doc/sphinx/arm/hammer.rst
@@ -7,12 +7,12 @@ Hammer is a Python 3 script that lets users automate tasks related to building
 Kea, such as setting up virtual machines, installing Kea dependencies,
 compiling Kea with various options, running unit-tests and more. This
 tool was created primarily for internal QA purposes at ISC and it is not
-included in the Kea distribution. However, it is available in the Kea
+included in the Kea distribution; however, it is available in the Kea
 git repository. This tool was developed primarily for internal purposes
-and ISC cannot guarantee its proper operation. If you decide to use it,
-please do so with care.
+and ISC cannot guarantee its proper operation. Administrators who decide to use it
+should do so with care.
 
- .. note::
+.. note::
 
    Use of this tool is completely optional. Everything it does can be
    done manually.
@@ -52,19 +52,18 @@ or in VirtualBox. For a list of supported systems, use the
      - 11.2: virtualbox
      - 12.0: virtualbox
 
-
 It is also possible to run the build locally, in the current system (if the OS
 is supported).
 
-First, you must install the Hammer dependencies: Vagrant
-and either VirtualBox or LXC. To make life easier, Hammer can install
+First, the Hammer dependencies must be installed: Vagrant
+and either VirtualBox or LXC. Hammer can install
 Vagrant and the required Vagrant plugins using the command:
 
 .. code-block:: console
 
    $ ./hammer.py ensure-hammer-deps
 
-VirtualBox and LXC need to be installed manually.
+VirtualBox and LXC must be installed manually.
 
 The basic functions provided by Hammer are to prepare the build environment
 and perform the actual build, and to run the unit tests locally in the current
@@ -74,9 +73,9 @@ system. This can be achieved by running the command:
 
    $ ./hammer.py build -p local
 
-The scope of the process can be defined using --with (-w) and --without
-(-x) options. By default the build command will build Kea with
-documentation, install it locally, and run unit tests.
+The scope of the process can be defined using the ``--with`` (``-w``) and ``--without``
+(``-x``) options. By default, the ``build`` command builds Kea with
+documentation, installs it locally, and runs unit tests.
 
 To exclude the installation and generation of docs, type:
 
@@ -84,12 +83,12 @@ To exclude the installation and generation of docs, type:
 
    $ ./hammer.py build -p local -x install docs
 
-The basic scope can be extended by: mysql, pgsql, cql, native-pkg,
+The basic scope can be extended by mysql, pgsql, cql, native-pkg,
 radius, shell, and forge.
 
- .. note::
+.. note::
 
-   To build Kea locally, Hammer dependencies like Vagrant are
+   If building Kea locally, Hammer dependencies like Vagrant are
    not needed.
 
 Hammer can be told to set up a new virtual machine with a specified
@@ -99,30 +98,27 @@ operating system, without the build:
 
    $ ./hammer.py prepare-system -p virtualbox -s freebsd -r 12.0
 
-This way we can prepare a system for our own use. To get to such a system
+This way, a system can be prepared for our own use. To get to such a system
 using SSH, invoke:
 
 .. code-block:: console
 
    $ ./hammer.py ssh -p virtualbox -s freebsd -r 12.0
 
-It is possible to speed up subsequent Hammer builds. To achieve this
-Hammer employs `ccache <https://ccache.samba.org/>`__. During
+It is possible to speed up subsequent Hammer builds via
+`ccache <https://ccache.samba.org/>`__. During
 compilation, ccache stores objects in a shared folder. In subsequent runs,
 instead of doing an actual compilation, ccache returns the stored earlier
-objects. The cache with these objects for reuse needs to be stored outside of VM
-or LXC. To indicate the folder, you must indicate the --ccache-dir
-parameter for Hammer. In the indicated folder, there are separate stored objects for each target
+objects. The cache with these objects for reuse must be stored outside of VM
+or LXC. To indicate the folder, the ``--ccache-dir``
+parameter for Hammer must be included. In the indicated folder, there are separate stored objects for each target
 operating system.
 
 .. code-block:: console
 
    $ ./hammer.py build -p lxc -s ubuntu -r 18.04 --ccache-dir ~/kea-ccache
 
-
-..
-
- .. note::
+.. note::
 
    ccache is currently only supported for LXC in Hammer; support
    for VirtualBox may be added later.