summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/users/configuring
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-08-02 15:03:15 -0400
committerNeale Ranns <nranns@cisco.com>2018-08-03 09:07:18 +0000
commitc64ba6dc6ab9e3b06feac1a86c2f59d7052609ce (patch)
tree7102af8eaebcf4d9296eb3c5519a5b72ed62a417 /docs/gettingstarted/users/configuring
parent5c482a9de3b28a5609b1c2029d1c2dc12466109c (diff)
docs: Incororate Scott's overall review
Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted/users/configuring')
-rw-r--r--docs/gettingstarted/users/configuring/hugepages.rst11
-rw-r--r--docs/gettingstarted/users/configuring/index.rst6
-rw-r--r--docs/gettingstarted/users/configuring/startup.rst5
3 files changed, 12 insertions, 10 deletions
diff --git a/docs/gettingstarted/users/configuring/hugepages.rst b/docs/gettingstarted/users/configuring/hugepages.rst
index 42f6aa30282..76ac7d0807d 100644
--- a/docs/gettingstarted/users/configuring/hugepages.rst
+++ b/docs/gettingstarted/users/configuring/hugepages.rst
@@ -3,11 +3,12 @@
Huge Pages
----------
-VPP requires *'hugepages'* to run. VPP will overwrite existing hugepage
-settings when VPP is installed. By default, VPP sets the number of hugepages on
-a system to 1024 2M hugepages (1G hugepages are no longer supported). This is
-the number of hugepages on the system, not just used by VPP. When VPP is
-installed, the following file is copied to the system and used to apply the
+VPP requires *'hugepages'* to run. VPP will overwrite existing hugepage settings
+when VPP is installed. By default, VPP sets the number of hugepages on a system
+to 1024 2M hugepages (1G hugepages are no longer supported). This is the number
+of hugepages on the system, not just used by VPP.
+
+When VPP is installed, the following file is copied to the system and used to apply the
hugepage settings on VPP installation and system reboot:
.. code-block:: console
diff --git a/docs/gettingstarted/users/configuring/index.rst b/docs/gettingstarted/users/configuring/index.rst
index 75c5276d8a5..f1244c61a4f 100644
--- a/docs/gettingstarted/users/configuring/index.rst
+++ b/docs/gettingstarted/users/configuring/index.rst
@@ -1,10 +1,10 @@
.. _configuring:
Configuring VPP
-===============
+==================
-There is some basic configuration that is need to run FD.io VPP. This section
-will describe some basic configuration.
+There is some basic configuration that is needed to run FD.io VPP. This section
+describes the basic configuration:
.. toctree::
:maxdepth: 2
diff --git a/docs/gettingstarted/users/configuring/startup.rst b/docs/gettingstarted/users/configuring/startup.rst
index 7dd2c996a80..8ce27eb676d 100644
--- a/docs/gettingstarted/users/configuring/startup.rst
+++ b/docs/gettingstarted/users/configuring/startup.rst
@@ -10,9 +10,10 @@ VPP Configuration File - 'startup.conf'
After a successful installation, VPP installs a startup config file named
-*'startup.conf'* in the *'/etc/vpp/'*' directory. This file can be tailored to
+*startup.conf* in the */etc/vpp/* directory. This file can be tailored to
make VPP run as desired, but contains default values for typical installations.
-Below are more details about this file and parameter and values it contains.
+
+Below are more details about this file and the parameters and values it contains.
Introduction
------------