From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bruce Richardson Subject: =?utf-8?q?=5BPATCH_2/3=5D_docs=3A_adjust_line_lengths_?= =?utf-8?q?in_FreeBSD_GSG_rst_files?= Date: Mon, 24 Nov 2014 15:48:56 +0000 Message-ID: <1416844136-4604-1-git-send-email-bruce.richardson@intel.com> References: <1416839034-26652-1-git-send-email-bruce.richardson@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable To: bruce.richardson-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org, dev-VfR2kkLFssw@public.gmane.org Return-path: In-Reply-To: <1416839034-26652-1-git-send-email-bruce.richardson-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces-VfR2kkLFssw@public.gmane.org Sender: "dev" The FreeBSD GSG rst files had very inconsistent line lengths for text within paragraph blocks. Sometimes a line would be very short, while ofte= n lines would be quite long. This patch adjusts the formatting of the rst files so that lines break at approx the 80-character mark, as is standard in the DPDK source code. Signed-off-by: Bruce Richardson --- doc/guides/freebsd_gsg/build_dpdk.rst | 110 +++++++++++++++------= ------ doc/guides/freebsd_gsg/build_sample_apps.rst | 80 ++++++++++--------- doc/guides/freebsd_gsg/intro.rst | 44 ++++++----- doc/guides/freebsd_gsg/sys_reqs.rst | 47 ++++++------ 4 files changed, 157 insertions(+), 124 deletions(-) diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_g= sg/build_dpdk.rst index 9b78840..8f72a5e 100644 --- a/doc/guides/freebsd_gsg/build_dpdk.rst +++ b/doc/guides/freebsd_gsg/build_dpdk.rst @@ -70,7 +70,8 @@ Where: =20 * TOOLCHAIN is: gcc =20 -The configuration files for the Intel=C2=AE DPDK targets can be found in= the DPDK/config directory in the form of: +The configuration files for the Intel=C2=AE DPDK targets can be found in= the DPDK/config +directory in the form of: =20 :: =20 @@ -79,10 +80,10 @@ The configuration files for the Intel=C2=AE DPDK targ= ets can be found in the DPDK/co .. note:: =20 Configuration files are provided with the RTE_MACHINE optimization l= evel set. - Within the configuration files, the RTE_MACHINE configuration value = is set to native, - which means that the compiled software is tuned for the platform on = which it is built. - For more information on this setting, and its possible values, - see the *Intel=C2=AE DPDK Programmers Guide*. + Within the configuration files, the RTE_MACHINE configuration value = is set + to native, which means that the compiled software is tuned for the p= latform + on which it is built. For more information on this setting, and its + possible values, see the *Intel=C2=AE DPDK Programmers Guide*. =20 To install and make the target, use gmake install T=3D CC=3Dgcc4= 8. =20 @@ -92,9 +93,8 @@ For example to compile for FreeBSD* use: =20 gmake install T=3Dx86_64-native-bsdapp-gcc CC=3Dgcc48 =20 -To prepare a target without building it, for example, -if the configuration changes need to be made before compilation, -use the gmake config T=3D command: +To prepare a target without building it, for example, if the configurati= on +changes need to be made before compilation, use the gmake config T=3D command: =20 .. code-block:: console =20 @@ -106,13 +106,14 @@ To build after configuration, change directory to .= /x86_64-native-bsdapp-gcc and =20 gmake CC=3Dgcc48 =20 -Browsing the Installed Intel=C2=AEDPDK Environment Target ----------------------------------------------------- +Browsing the Installed Intel=C2=AE DPDK Environment Target +----------------------------------------------------- =20 -Once a target is created, it contains all the libraries -and header files for the Intel=C2=AE DPDK environment that are required = to build customer applications. -In addition, the test and testpmd applications are built under the build= /app directory, which may be used for testing. -A kmod directory is also present that contains the kernel modules to ins= tall: +Once a target is created, it contains all the libraries and header files= for the +Intel=C2=AE DPDK environment that are required to build customer applica= tions. +In addition, the test and testpmd applications are built under the build= /app +directory, which may be used for testing. A kmod directory is also pres= ent that +contains the kernel modules to install: =20 .. code-block:: console =20 @@ -122,17 +123,19 @@ A kmod directory is also present that contains the = kernel modules to install: Loading the Intel=C2=AE DPDK contigmem Module ---------------------------------------- =20 -To run any Intel=C2=AE DPDK application, the contigmem module must be lo= aded into the running kernel. -The module is found in the kmod sub-directory of the Intel=C2=AE DPDK ta= rget directory. -The module can be loaded using kldload (assuming that the current direct= ory is the Intel=C2=AE DPDK target directory): +To run any Intel=C2=AE DPDK application, the contigmem module must be lo= aded into the +running kernel. The module is found in the kmod sub-directory of the Int= el=C2=AE DPDK +target directory. The module can be loaded using kldload (assuming that = the +current directory is the Intel=C2=AE DPDK target directory): =20 .. code-block:: console =20 kldload ./kmod/contigmem.ko =20 -It is advisable to include the loading of the contigmem module during th= e boot process to avoid issues -with potential memory fragmentation during later system up time. -This can be achieved by copying the module to the /boot/kernel/ director= y and placing the following into /boot/loader.conf: +It is advisable to include the loading of the contigmem module during th= e boot +process to avoid issues with potential memory fragmentation during later= system +up time. This can be achieved by copying the module to the /boot/kernel= / +directory and placing the following into /boot/loader.conf: =20 :: =20 @@ -140,11 +143,13 @@ This can be achieved by copying the module to the /= boot/kernel/ directory and pl =20 .. note:: =20 - The contigmem_load directive should be placed after any definitions = of hw.contigmem.num_buffers - and hw.contigmem.buffer_size if the default values are not to be use= d. + The contigmem_load directive should be placed after any definitions = of + hw.contigmem.num_buffers and hw.contigmem.buffer_size if the default= values + are not to be used. =20 -An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/con= tigmem.ko: Exec format error, -is generally attributed to not having enough contiguous memory available= and can be verified via dmesg or /var/log/messages: +An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/con= tigmem.ko: +Exec format error, is generally attributed to not having enough contiguo= us memory +available and can be verified via dmesg or /var/log/messages: =20 .. code-block:: console =20 @@ -155,8 +160,10 @@ To avoid this error, reduce the number of buffers or= the buffer size. Loading the Intel=C2=AE DPDK nic_uio Module -------------------------------------- =20 -After loading the contigmem module, the nic_uio must also be loaded into= the running kernel prior to running any Intel=C2=AE DPDK application. -This module must be loaded using the kldload command as shown below (ass= uming that the current directory is the Intel=C2=AE DPDK target directory= ). +After loading the contigmem module, the nic_uio must also be loaded into= the +running kernel prior to running any Intel=C2=AE DPDK application. This = module must +be loaded using the kldload command as shown below (assuming that the cu= rrent +directory is the Intel=C2=AE DPDK target directory). =20 .. code-block:: console =20 @@ -164,12 +171,13 @@ This module must be loaded using the kldload comman= d as shown below (assuming th =20 .. note:: =20 - Currently loaded modules can be seen by using the kldstat command. - A module can be removed from the running kernel by using kldunload <= module_name>. - While the nic_uio module can be loaded during boot, - the module load order cannot be guaranteed and in the case where onl= y some ports are bound to nic_uio - and others remain in use by the original driver, it is necessary to = load nic_uio after booting into the kernel, - specifically after the original driver has been loaded. + Currently loaded modules can be seen by using the kldstat command. = A module + can be removed from the running kernel by using kldunload . + While the nic_uio module can be loaded during boot, the module load = order + cannot be guaranteed and in the case where only some ports are bound= to + nic_uio and others remain in use by the original driver, it is neces= sary to + load nic_uio after booting into the kernel, specifically after the o= riginal + driver has been loaded. =20 To load the module during boot, copy the nic_uio module to /boot/kernel = and place the following into /boot/loader.conf: =20 @@ -184,8 +192,8 @@ To load the module during boot, copy the nic_uio modu= le to /boot/kernel and plac Binding Network Ports to the nic_uio Module ------------------------------------------- =20 -By default, the nic_uio module will take ownership of network ports if t= hey are recognized Intel=C2=AE DPDK devices -and are not owned by another module. +By default, the nic_uio module will take ownership of network ports if t= hey are +recognized Intel=C2=AE DPDK devices and are not owned by another module. =20 Device ownership can be viewed using the pciconf -l command. =20 @@ -209,45 +217,53 @@ The first column constitutes three components: =20 Where no driver is associated with a device, the device name will be non= e. =20 -By default, the FreeBSD* kernel will include built-in drivers for the mo= st common devices; -a kernel rebuild would normally be required to either remove the drivers= or configure them as loadable modules. +By default, the FreeBSD* kernel will include built-in drivers for the mo= st common +devices; a kernel rebuild would normally be required to either remove th= e drivers +or configure them as loadable modules. =20 -To avoid building a custom kernel, the nic_uio module can detach a netwo= rk port from its current device driver. -This is achieved by setting the hw.nic_uio.bdfs kernel environment varia= ble prior to loading nic_uio, as follows: +To avoid building a custom kernel, the nic_uio module can detach a netwo= rk port +from its current device driver. This is achieved by setting the hw.nic_= uio.bdfs +kernel environment variable prior to loading nic_uio, as follows: =20 :: =20 hw.nic_uio.bdfs=3D"b:d:f,b:d:f,..." =20 -Where a comma separated list of selectors is set, the list must not cont= ain any whitespace. +Where a comma separated list of selectors is set, the list must not cont= ain any +whitespace. =20 -For example to re-bind ix2@pci0:2:0:0 and ix3@pci0:2:0: to the nic_uio m= odule upon loading, use the following command: +For example to re-bind ix2@pci0:2:0:0 and ix3@pci0:2:0: to the nic_uio m= odule +upon loading, use the following command: =20 .. code-block:: console =20 kenv hw.nic_uio.bdfs=3D"2:0:0,2:0:1" =20 -The variable can also be specified during boot by placing the following = into /boot/ loader.conf: +The variable can also be specified during boot by placing the following = into +/boot/loader.conf: =20 :: =20 hw.nic_uio.bdfs=3D"2:0:0,2:0:1" =20 -To restore the original device binding, -it is necessary to reboot FreeBSD* if the original driver has been compi= led into the kernel. +To restore the original device binding, it is necessary to reboot FreeBS= D* if the +original driver has been compiled into the kernel. =20 For example to rebind some or all ports to the original driver: =20 -Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if speci= fied there for persistency, then; +Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if speci= fied there +for persistency, then; =20 .. code-block:: console =20 reboot =20 -If rebinding to a driver that is a loadable module, the network port bin= ding can be reset without rebooting. -This requires the unloading of the nic_uio module and the original drive= r. +If rebinding to a driver that is a loadable module, the network port bin= ding can +be reset without rebooting. This requires the unloading of the nic_uio = module +and the original driver. =20 -Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if spe= cified there for persistency. +Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if spe= cified +there for persistency. =20 .. code-block:: console =20 diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/fr= eebsd_gsg/build_sample_apps.rst index 7e85467..3b2d0c1 100644 --- a/doc/guides/freebsd_gsg/build_sample_apps.rst +++ b/doc/guides/freebsd_gsg/build_sample_apps.rst @@ -31,14 +31,15 @@ Compiling and Running Sample Applications =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -The chapter describes how to compile and run applications in an Intel=C2= =AE DPDK environment. -It also provides a pointer to where sample applications are stored. +The chapter describes how to compile and run applications in an Intel=C2= =AE DPDK +environment. It also provides a pointer to where sample applications are= stored. =20 Compiling a Sample Application ------------------------------ =20 -Once an Intel=C2=AE DPDK target environment directory has been created (= such as x86_64-native-bsdapp-gcc), -it contains all libraries and header files required to build an applicat= ion. +Once an Intel=C2=AE DPDK target environment directory has been created (= such as +x86_64-native-bsdapp-gcc), it contains all libraries and header files re= quired +to build an application. =20 When compiling an application in the FreeBSD* environment on the Intel=C2= =AE DPDK, the following variables must be exported: @@ -48,15 +49,15 @@ the following variables must be exported: * RTE_TARGET - Points to the Intel=C2=AE DPDK target environment direc= tory. For FreeBSD*, this is the x86_64-native-bsdapp-gcc directory. =20 -The following is an example of creating the helloworld application, -which runs in the Intel=C2=AE DPDK FreeBSD* environment. -This example may be found in the ${RTE_SDK}/examples directory. +The following is an example of creating the helloworld application, whic= h runs +in the Intel=C2=AE DPDK FreeBSD* environment. This example may be found = in the +${RTE_SDK}/examples directory. =20 -The directory contains the main.c file. -This file, when combined with the libraries in the Intel=C2=AE DPDK targ= et environment, -calls the various functions to initialize the Intel=C2=AE DPDK environme= nt, -then launches an entry point (dispatch application) for each core to be = utilized. -By default, the binary is generated in the build directory. +The directory contains the main.c file. This file, when combined with t= he +libraries in the Intel=C2=AE DPDK target environment, calls the various = functions to +initialize the Intel=C2=AE DPDK environment, then launches an entry poin= t (dispatch +application) for each core to be utilized. By default, the binary is ge= nerated +in the build directory. =20 .. code-block:: console =20 @@ -73,9 +74,11 @@ By default, the binary is generated in the build direc= tory. =20 .. note:: =20 - In the above example, helloworld was in the directory structure of t= he Intel=C2=AE DPDK. - However, it could have been located outside the directory structure = to keep the Intel=C2=AE DPDK structure intact. - In the following case, the helloworld application is copied to a new= directory as a new starting point. + In the above example, helloworld was in the directory structure of t= he + Intel=C2=AE DPDK. However, it could have been located outside the d= irectory + structure to keep the Intel=C2=AE DPDK structure intact. In the fol= lowing case, + the helloworld application is copied to a new directory as a new sta= rting + point. =20 .. code-block:: console =20 @@ -96,8 +99,9 @@ Running a Sample Application =20 #. Any ports to be used by the application must be already bound to the= nic_uio module, as described in section Section 3.6, =E2=80=9C , =E2=80=9D prior to = running the application. - The application is linked with the Intel=C2=AE DPDK target environme= nt's Environment Abstraction Layer (EAL) library, - which provides some options that are generic to every Intel=C2=AE DP= DK application. + The application is linked with the Intel=C2=AE DPDK target environme= nt's Environment + Abstraction Layer (EAL) library, which provides some options that ar= e generic + to every Intel=C2=AE DPDK application. =20 The following is the list of options that can be given to the EAL: =20 @@ -107,25 +111,27 @@ The following is the list of options that can be gi= ven to the EAL: =20 .. note:: =20 - EAL has a common interface between all operating systems and is base= d on the Linux* notation for PCI devices. - The device and function separator used is a ":" rather than "." as s= een with pciconf on FreeBSD*. - For example, a FreeBSD* device selector of pci0:2:0:1 is referred to= as 02:00.1 in EAL. + EAL has a common interface between all operating systems and is base= d on the + Linux* notation for PCI devices. The device and function separator = used is + a ":" rather than "." as seen with pciconf on FreeBSD*. For example= , a + FreeBSD* device selector of pci0:2:0:1 is referred to as 02:00.1 in = EAL. =20 The EAL options for FreeBSD* are as follows: =20 * -c COREMASK - : A hexadecimal bit mask of the cores to run on. - Note that core numbering can change between platforms and should be = determined beforehand. + : A hexadecimal bit mask of the cores to run on. Note that core num= bering + can change between platforms and should be determined beforehand. =20 * -n NUM : Number of memory channels per processor socket. =20 * -b - : blacklisting of ports; prevent EAL from using specified PCI device= (multiple -b options are allowed). + : blacklisting of ports; prevent EAL from using specified PCI device + (multiple -b options are allowed). =20 * --use-device - : use the specified ethernet device(s) only. - Use comma-separate <[domain:]bus:devid.func> values. Cannot be used = with -b option. + : use the specified ethernet device(s) only. Use comma-separate + <[domain:]bus:devid.func> values. Cannot be used with -b option. =20 * -r NUM : Number of memory ranks. @@ -153,9 +159,9 @@ Other options, specific to Linux* and are not support= ed under FreeBSD* are as fo =20 The -c and the -n options are mandatory; the others are optional. =20 -Copy the Intel=C2=AE DPDK application binary to your target, -then run the application as follows (assuming the platform has four memo= ry channels, -and that cores 0-3 are present and are to be used for running the applic= ation): +Copy the Intel=C2=AE DPDK application binary to your target, then run th= e application +as follows (assuming the platform has four memory channels, and that cor= es 0-3 +are present and are to be used for running the application): =20 .. code-block:: console =20 @@ -163,18 +169,20 @@ and that cores 0-3 are present and are to be used f= or running the application): =20 .. note:: =20 - The --proc-type and --file-prefix EAL options are used for running m= ultiple Intel=C2=AE DPDK processes. - See the =E2=80=9CMulti-process Sample Application=E2=80=9D chapter i= n the - *Intel=C2=AE DPDK Sample Applications User Guide and the Intel=C2=AE= DPDK Programmers Guide* for more details. + The --proc-type and --file-prefix EAL options are used for running m= ultiple + Intel=C2=AE DPDK processes. See the =E2=80=9CMulti-process Sample A= pplication=E2=80=9D chapter + in the *Intel=C2=AE DPDK Sample Applications User Guide and the Inte= l=C2=AE DPDK + Programmers Guide* for more details. =20 Running Intel=C2=AEDPDK Applications Without Root Privileges ------------------------------------------------------- =20 -Although applications using the Intel=C2=AE DPDK use network ports and o= ther hardware resources directly, -with a number of small permission adjustments, -it is possible to run these applications as a user other than =E2=80=9Cr= oot=E2=80=9D. -To do so, the ownership, or permissions, on the following file system ob= jects should be adjusted to ensure -that the user account being used to run the Intel=C2=AE DPDK application= has access to them: +Although applications using the Intel=C2=AE DPDK use network ports and o= ther hardware +resources directly, with a number of small permission adjustments, it is= possible +to run these applications as a user other than =E2=80=9Croot=E2=80=9D. = To do so, the ownership, +or permissions, on the following file system objects should be adjusted = to ensure +that the user account being used to run the Intel=C2=AE DPDK application= has access +to them: =20 * The userspace-io device files in /dev, for example, /dev/uio0, /dev/= uio1, and so on =20 diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/in= tro.rst index bb19615..fc27ed0 100644 --- a/doc/guides/freebsd_gsg/intro.rst +++ b/doc/guides/freebsd_gsg/intro.rst @@ -31,12 +31,14 @@ Introduction =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -This document contains instructions for installing and configuring the I= ntel=C2=AE Data Plane Development Kit(Intel=C2=AE DPDK) software. -It is designed to get customers up and running quickly. -The document describes how to compile and run an Intel=C2=AE DPDK applic= ation in a FreeBSD* application (bsdapp) environment, -without going deeply into detail. +This document contains instructions for installing and configuring the I= ntel=C2=AE +Data Plane Development Kit(Intel=C2=AE DPDK) software. It is designed t= o get customers +up and running quickly. The document describes how to compile and run a= n Intel=C2=AE +DPDK application in a FreeBSD* application (bsdapp) environment, without= going +deeply into detail. =20 -For a comprehensive guide to installing and using FreeBSD*, the followin= g handbook is available from the FreeBSD* Documentation Project: +For a comprehensive guide to installing and using FreeBSD*, the followin= g +handbook is available from the FreeBSD* Documentation Project: =20 `http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html `_ =20 @@ -45,30 +47,36 @@ DocumentationRoadmap =20 The following is a list of Intel=C2=AE DPDK documents in the suggested r= eading order: =20 -* **Release Notes** : Provides release-specific information, including= supported features, limitations, fixed issues, known issues and so on. - Also, provides the answers to frequently asked questions in FAQ form= at. +* **Release Notes** : Provides release-specific information, including= supported + features, limitations, fixed issues, known issues and so on. Also, = provides the + answers to frequently asked questions in FAQ format. =20 -* **Getting Started Guide** (this document): Describes how to install = and configure the Intel=C2=AE DPDK; - designed to get users up and running quickly with the software. +* **Getting Started Guide** (this document): Describes how to install = and + configure the Intel=C2=AE DPDK; designed to get users up and running= quickly with the + software. =20 * **Programmer's Guide**: Describes: =20 - * The software architecture and how to use it (through examples), = specifically in a Linux* application (linuxapp) environment + * The software architecture and how to use it (through examples), + specifically in a Linux* application (linuxapp) environment =20 - * The content of the Intel=C2=AE DPDK, the build system - (including the commands that can be used in the root Intel=C2=AE= DPDK Makefile to build the development kit and an application) - and guidelines for porting an application + * The content of the Intel=C2=AE DPDK, the build system (including= the commands + that can be used in the root Intel=C2=AE DPDK Makefile to build = the development + kit and an application) and guidelines for porting an applicatio= n =20 - * Optimizations used in the software and those that should be cons= idered for new development + * Optimizations used in the software and those that should be cons= idered + for new development =20 A glossary of terms is also provided. =20 -* **API Reference**: Provides detailed information about Intel=C2=AE D= PDK functions, data structures and other programming constructs. +* **API Reference**: Provides detailed information about Intel=C2=AE D= PDK functions, + data structures and other programming constructs. =20 * **Sample Applications User Guide**: Describes a set of sample applic= ations. - Each chapter describes a sample application that showcases specific = functionality and provides instructions on how to compile, - run and use the sample application. + Each chapter describes a sample application that showcases specific = functionality + and provides instructions on how to compile, run and use the sample = application. =20 .. note:: =20 - These documents are available for download as a separate documentati= on package at the same location as the Intel=C2=AE DPDK code package. + These documents are available for download as a separate documentati= on + package at the same location as the Intel=C2=AE DPDK code package. diff --git a/doc/guides/freebsd_gsg/sys_reqs.rst b/doc/guides/freebsd_gsg= /sys_reqs.rst index 2314f39..8ce0ba4 100644 --- a/doc/guides/freebsd_gsg/sys_reqs.rst +++ b/doc/guides/freebsd_gsg/sys_reqs.rst @@ -39,27 +39,28 @@ Compilationofthe Intel=C2=AE DPDK .. note:: =20 The Intel=C2=AE DPDK and its applications requires the GNU make syst= em (gmake) - and the GNU Compiler Collection (gcc) to build on FreeBSD*. - The installation of these tools is covered in this section. + and the GNU Compiler Collection (gcc) to build on FreeBSD*. The + installation of these tools is covered in this section. =20 **Required Tools:** =20 .. note:: =20 - Testing has been performed using FreeBSD* 9.2-RELEASE (x86_64), - FreeBSD* 10.0-RELEASE (x86_64) and requires the installation of the = kernel sources, - which should be included during the installation of FreeBSD*. - The Intel=C2=AE DPDK also requires the use of FreeBSD* ports to comp= ile and function. + Testing has been performed using FreeBSD* 9.2-RELEASE (x86_64), Free= BSD* + 10.0-RELEASE (x86_64) and requires the installation of the kernel so= urces, + which should be included during the installation of FreeBSD*. The I= ntel=C2=AE + DPDK also requires the use of FreeBSD* ports to compile and function= . =20 -To use the FreeBSD* ports system, -it is required to update and extract the FreeBSD* ports tree by issuing = the following commands: +To use the FreeBSD* ports system, it is required to update and extract t= he FreeBSD* +ports tree by issuing the following commands: =20 .. code-block:: console =20 root@host:~ # portsnap fetch root@host:~ # portsnap extract =20 -If the environment requires proxies for external communication, these ca= n be set using: +If the environment requires proxies for external communication, these ca= n be set +using: =20 .. code-block:: console =20 @@ -107,8 +108,8 @@ The ports required and their locations are as follows= : =20 * /usr/src/contrib/libexecinfo =20 -When running the make config-recursive command, a dialog may be presente= d to the user. -For the installation of the Intel=C2=AE DPDK, the default options were u= sed. +When running the make config-recursive command, a dialog may be presente= d to the +user. For the installation of the Intel=C2=AE DPDK, the default options = were used. =20 .. note:: =20 @@ -120,24 +121,24 @@ Running Intel=C2=AE DPDK Applications -------------------------------- =20 To run an Intel=C2=AE DPDK application, physically contiguous memory is = required. -In the absence of non-transparent superpages, -the included sources for the contigmem kernel module provides the abilit= y to -present contiguous blocks of memory for the Intel=C2=AE DPDK to use. -Section 3.4, =E2=80=9CLoading the Intel=C2=AE DPDK contigmem Module=E2=80= =9D on page 8 -for details on the loading of this module. +In the absence of non-transparent superpages, the included sources for t= he +contigmem kernel module provides the ability to present contiguous block= s of +memory for the Intel=C2=AE DPDK to use. Section 3.4, =E2=80=9CLoading t= he Intel=C2=AE DPDK +Contigmem Module=E2=80=9D on page 8 for details on the loading of this m= odule. =20 -Using Intel=C2=AE DPDK contigmem Module +Using Intel=C2=AE DPDK Contigmem Module ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 -The amount of physically contiguous memory along with the number of phys= ically contiguous blocks -can be set at runtime and prior to module loading using: +The amount of physically contiguous memory along with the number of phys= ically +contiguous blocks can be set at runtime and prior to module loading usin= g: =20 .. code-block:: console =20 root@host:~ # kenv hw.contigmem.num_buffers=3Dn root@host:~ # kenv hw.contigmem.buffer_size=3Dm =20 -The kernel environment variables can also be specified during boot by pl= acing the following in /boot/loader.conf: +The kernel environment variables can also be specified during boot by pl= acing the +following in /boot/loader.conf: =20 :: =20 @@ -149,9 +150,9 @@ The variables can be inspected using the following co= mmand: =20 root@host:~ # sysctl -a hw.contigmem =20 -Where n is the number of blocks and m is the size in bytes of each area = of contiguous memory. -A default of two buffers of size 1073741824 bytes (1 Gigabyte) each is s= et during module load -if they are not specified in the environment. +Where n is the number of blocks and m is the size in bytes of each area = of +contiguous memory. A default of two buffers of size 1073741824 bytes (1= Gigabyte) +each is set during module load if they are not specified in the environm= ent. =20 .. note:: =20 --=20 1.9.3