aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/users/configutil/commandtwo.rst
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/configutil/commandtwo.rst
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/configutil/commandtwo.rst')
-rw-r--r--docs/gettingstarted/users/configutil/commandtwo.rst38
1 files changed, 20 insertions, 18 deletions
diff --git a/docs/gettingstarted/users/configutil/commandtwo.rst b/docs/gettingstarted/users/configutil/commandtwo.rst
index 0d06c1410e5..c30663f5df9 100644
--- a/docs/gettingstarted/users/configutil/commandtwo.rst
+++ b/docs/gettingstarted/users/configutil/commandtwo.rst
@@ -4,10 +4,12 @@
Dry Run
*******
-With the config utility dry run option the important configuration files are created
-so that the user can examine them and then if they look reasonable apply them with
-option 3. The files for **Ubuntu** can be found in the root directory /usr/local/vpp/vpp-config/dryrun
-and for **Centos** in /usr/vpp/vpp-config/dryrun.
+With command option '2' (the config utility *dry run* option) the important
+configuration files are created so that the user can examine them, and then
+if they look reasonable apply them with command option 3.
+
+The files for **Ubuntu** can be found in the root directory */usr/local/vpp/vpp-config/dryrun*
+and for **Centos** in directory */usr/vpp/vpp-config/dryrun*.
The important configuration files are **/etc/vpp/startup.conf**, **/etc/sysctl.d/80-vpp.conf**,
and **/etc/default/grub**
@@ -15,32 +17,32 @@ and **/etc/default/grub**
Startup.conf
============
-FD.io VPP startup parameters are configured in the file **/etc/vpp/startup.conf**. The
-utility creates this file under the vpp-config root directory in vpp/startup.conf.
-the values in this file come from the questions asked about the devices, cores, rx queues,
+FD.io VPP startup parameters are configured in the file **/etc/vpp/startup.conf**.
+The utility creates this file under the *vpp-config* root directory in the file *vpp/startup.conf*.
+The values in this file come from the questions asked about the devices, cores, rx queues,
and tcp parameters.
80-vpp.conf
-===========
+============
The huge page configuration comes by setting values in the file **/etc/sysctl.d/80-vpp.conf**.
-The utility creates the file under the root directory in sysctl.d/80-vpp.conf. When asked the
-question about huge pages the correct values are put in the dryrin file.
+The utility creates the file under the root directory in the file *sysctl.d/80-vpp.conf*. When asked the
+question about huge pages the correct values are put in the dryrun file.
grub
====
-CPUs can be isolated for use by VPP or other processes such as VMs using the grub configuration
-file. This file is **/etc/default/grub**. This file must be modified with care. It is possible to
-make your system unusable if this file is modified incorrectly. The dry run file is located under
-the vpp-config root directory and then default.
+CPUs can be isolated for use by VPP or other processes such as VMs using the grub
+configuration file. This file is **/etc/default/grub**. This file must be modified with
+care. It is possible to make your system unusable if this file is modified incorrectly.
+The dry run file is located under the *vpp-config* root directory and then default.
-*********************
+***********************
Executing the Dry Run
-*********************
+***********************
-The following is an example of how to execute a dry run. Defaults should be picked first and then
-the values increased accordingly.
+The following is an example of how to execute a dry run. Defaults should be picked first,
+and then the values increased accordingly.
.. code-block:: console