From c64ba6dc6ab9e3b06feac1a86c2f59d7052609ce Mon Sep 17 00:00:00 2001 From: John DeNisco Date: Thu, 2 Aug 2018 15:03:15 -0400 Subject: docs: Incororate Scott's overall review Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e Signed-off-by: John DeNisco --- .../users/configutil/commandfour.rst | 10 +++--- .../gettingstarted/users/configutil/commandone.rst | 4 +-- .../users/configutil/commandthree.rst | 13 ++++---- .../gettingstarted/users/configutil/commandtwo.rst | 38 ++++++++++++---------- .../users/configutil/usingvppconfig.rst | 9 ++--- 5 files changed, 39 insertions(+), 35 deletions(-) (limited to 'docs/gettingstarted/users/configutil') diff --git a/docs/gettingstarted/users/configutil/commandfour.rst b/docs/gettingstarted/users/configutil/commandfour.rst index 27cac824e4a..6a1b82e1da5 100644 --- a/docs/gettingstarted/users/configutil/commandfour.rst +++ b/docs/gettingstarted/users/configutil/commandfour.rst @@ -4,11 +4,11 @@ List/Install/Uninstall VPP ************************** -With option "4" the user can list, install or uninstall the FD.io VPP packages. If there -are packages already installed, the packages will be listed and then the user will be asked -if the packages should be uninstalled. If no packages are installed the user will be asked if -the FD.io packages should be installed. The packages installed will be the latest released -packages. +With command option "4" the user can list, install, or uninstall the FD.io VPP +packages. If there are packages already installed, then the packages will be listed +and the user will be asked if the packages should be uninstalled. If no packages are +installed, then the user will be asked if the FD.io packages should be installed. The +packages installed will be the latest released packages. Uninstalling the packages: diff --git a/docs/gettingstarted/users/configutil/commandone.rst b/docs/gettingstarted/users/configutil/commandone.rst index 9d63809b96b..33b6dbb04ce 100644 --- a/docs/gettingstarted/users/configutil/commandone.rst +++ b/docs/gettingstarted/users/configutil/commandone.rst @@ -4,9 +4,9 @@ Show System Information *********************** -With option "1" the user can inspect the system characteristics. +With command option "1" the user can inspect the system characteristics. -This example shows a system that VPP has not yet been installed. +This example shows a system that has not yet had VPP installed. .. code-block:: console diff --git a/docs/gettingstarted/users/configutil/commandthree.rst b/docs/gettingstarted/users/configutil/commandthree.rst index c4c44292fd0..589a3671acf 100644 --- a/docs/gettingstarted/users/configutil/commandthree.rst +++ b/docs/gettingstarted/users/configutil/commandthree.rst @@ -1,13 +1,14 @@ .. _config-command-three: -*********************** +************************ Apply the Configuration -*********************** +************************ -After the configuration files have been examined and are correct. The configuration -can be applied. After the configuration is applied use option "1" to check the -system configuration. Notice the default is NOT to change the grub file. If the option -to change the grub command line is selected a reboot of the system will be required. +After the configuration files have been examined and verified as correct, then the +configuration can be applied by using command option '3'. After the configuration +is applied, use option "1" to check the system configuration. Notice the default is +NOT to change the grub file. If the option to change the grub command line is selected, +then a reboot of the system will be required. .. code-block:: console 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 diff --git a/docs/gettingstarted/users/configutil/usingvppconfig.rst b/docs/gettingstarted/users/configutil/usingvppconfig.rst index 4f1ce6c3c30..8694a83341f 100644 --- a/docs/gettingstarted/users/configutil/usingvppconfig.rst +++ b/docs/gettingstarted/users/configutil/usingvppconfig.rst @@ -8,14 +8,15 @@ The vpp-config utility provides the user with several different menus. This allo user to configure ports, some performance characteristics, the number of huge pages and install/uninstall the released FD.io packages. -It is recommended that the menu options are executed in this order. +It is recommended that the menu command options, noted below as *"x)"*, are run in +this order (command option 4 first, then options 1,2,3): #. :ref:`4) List/Install/Uninstall VPP ` #. :ref:`1) Show basic system information ` #. :ref:`2) Dry Run ` #. :ref:`3) Full Configuration ` -Once vpp-config is installed as a root user execute the following +Once vpp-config is installed as a root user, then run the following code: .. code-block:: console @@ -44,8 +45,8 @@ Once vpp-config is installed as a root user execute the following Default Values ============== -If you do not choose to modify the default for any of the questions prompted by vpp-config, -you may press the ENTER key to select the default options: +If you do not choose to modify the default for any of the questions prompted by vpp-config, then +you may press the **ENTER** key to select the default options: * Questions that ask [Y/n], the capital letter Y is the default answer. * Numbers have their default within brackets, such as in [1024], the 1024 is the default. -- cgit 1.2.3-korg