DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8
@ 2014-11-24 14:23 Bruce Richardson
  2014-11-24 14:23 ` [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated Bruce Richardson
                   ` (3 more replies)
  0 siblings, 4 replies; 13+ messages in thread
From: Bruce Richardson @ 2014-11-24 14:23 UTC (permalink / raw)
  To: dev

This patch set updates the FreeBSD GSG for 1.8, mainly by
reworking the document to have installation via the ports
collection as the recommended installation path. Other
adjustments in the set involve updating all docs to use
an auto-generated, rather than hard-coded date, and to have
the FreeBSD GSG use a fairly standard line length accross the
board.

Bruce Richardson (3):
  docs: change hardcoded date to auto-generated
  docs: adjust line lengths in FreeBSD GSG rst files
  docs: update FreeBSD GSG to document ports install

 doc/guides/freebsd_gsg/build_dpdk.rst         | 295 ++++++++++++++++++--------
 doc/guides/freebsd_gsg/build_sample_apps.rst  |  94 ++++----
 doc/guides/freebsd_gsg/index.rst              |   4 +-
 doc/guides/freebsd_gsg/install_from_ports.rst | 162 ++++++++++++++
 doc/guides/freebsd_gsg/intro.rst              |  55 +++--
 doc/guides/freebsd_gsg/sys_reqs.rst           | 163 --------------
 doc/guides/linux_gsg/index.rst                |   2 +-
 doc/guides/prog_guide/index.rst               |   2 +-
 doc/guides/rel_notes/index.rst                |   2 +-
 doc/guides/sample_app_ug/index.rst            |   2 +-
 doc/guides/testpmd_app_ug/index.rst           |   2 +-
 11 files changed, 470 insertions(+), 313 deletions(-)
 create mode 100644 doc/guides/freebsd_gsg/install_from_ports.rst
 delete mode 100644 doc/guides/freebsd_gsg/sys_reqs.rst

-- 
1.9.3

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated
  2014-11-24 14:23 [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
@ 2014-11-24 14:23 ` Bruce Richardson
  2014-11-26 10:38   ` Iremonger, Bernard
  2014-11-24 14:43 ` [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 13+ messages in thread
From: Bruce Richardson @ 2014-11-24 14:23 UTC (permalink / raw)
  To: dev

The index.html file for each of the "guide" docs had a hard-coded
date value in them of June 2014. Rather than update each of these
for each revision, just use the |today| directive to insert the date
at which the document was generated.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/freebsd_gsg/index.rst    | 2 +-
 doc/guides/linux_gsg/index.rst      | 2 +-
 doc/guides/prog_guide/index.rst     | 2 +-
 doc/guides/rel_notes/index.rst      | 2 +-
 doc/guides/sample_app_ug/index.rst  | 2 +-
 doc/guides/testpmd_app_ug/index.rst | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/guides/freebsd_gsg/index.rst b/doc/guides/freebsd_gsg/index.rst
index da5be85..90915a8 100644
--- a/doc/guides/freebsd_gsg/index.rst
+++ b/doc/guides/freebsd_gsg/index.rst
@@ -31,7 +31,7 @@
 Getting Started Guide for FreeBSD
 =================================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/linux_gsg/index.rst b/doc/guides/linux_gsg/index.rst
index 11ee387..d4b7c97 100644
--- a/doc/guides/linux_gsg/index.rst
+++ b/doc/guides/linux_gsg/index.rst
@@ -31,7 +31,7 @@
 Getting Started Guide
 =====================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index e0ac8f4..78016d7 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -31,7 +31,7 @@
 Programmer's Guide
 ==================
 
-June 2014
+|today|
 
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE,
diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst
index 347f67b..e9a3d21 100644
--- a/doc/guides/rel_notes/index.rst
+++ b/doc/guides/rel_notes/index.rst
@@ -33,7 +33,7 @@ Release Notes
 
 Package Version: 1.7
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index ad2ca28..7555bce 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -31,7 +31,7 @@
 Sample Applications User Guide
 ==============================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/testpmd_app_ug/index.rst
index e89fad6..d1ad182 100644
--- a/doc/guides/testpmd_app_ug/index.rst
+++ b/doc/guides/testpmd_app_ug/index.rst
@@ -31,7 +31,7 @@
 Testpmd Application User Guide
 ==============================
 
-June 2014
+|today|
 
 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
 NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
-- 
1.9.3

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8
  2014-11-24 14:23 [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
  2014-11-24 14:23 ` [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated Bruce Richardson
@ 2014-11-24 14:43 ` Bruce Richardson
  2014-11-24 15:25   ` Thomas Monjalon
  2014-11-24 15:48 ` [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Bruce Richardson
  2014-11-24 15:50 ` [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install Bruce Richardson
  3 siblings, 1 reply; 13+ messages in thread
From: Bruce Richardson @ 2014-11-24 14:43 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

On Mon, Nov 24, 2014 at 02:23:51PM +0000, Bruce Richardson wrote:
> This patch set updates the FreeBSD GSG for 1.8, mainly by
> reworking the document to have installation via the ports
> collection as the recommended installation path. Other
> adjustments in the set involve updating all docs to use
> an auto-generated, rather than hard-coded date, and to have
> the FreeBSD GSG use a fairly standard line length accross the
> board.
> 
> Bruce Richardson (3):
>   docs: change hardcoded date to auto-generated
>   docs: adjust line lengths in FreeBSD GSG rst files
>   docs: update FreeBSD GSG to document ports install
>
Hi Thomas,

is there some restriction on character encoding in emails? I see that only the
first of my three patches made it through, and I suspect that the presence of the
(R) symbol [as in Intel(R) DPDK] may have prevented the other patches from 
getting through.

/Bruce

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8
  2014-11-24 14:43 ` [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
@ 2014-11-24 15:25   ` Thomas Monjalon
  2014-11-24 15:45     ` Bruce Richardson
  0 siblings, 1 reply; 13+ messages in thread
From: Thomas Monjalon @ 2014-11-24 15:25 UTC (permalink / raw)
  To: Bruce Richardson; +Cc: dev

2014-11-24 14:43, Bruce Richardson:
> On Mon, Nov 24, 2014 at 02:23:51PM +0000, Bruce Richardson wrote:
> > This patch set updates the FreeBSD GSG for 1.8, mainly by
> > reworking the document to have installation via the ports
> > collection as the recommended installation path. Other
> > adjustments in the set involve updating all docs to use
> > an auto-generated, rather than hard-coded date, and to have
> > the FreeBSD GSG use a fairly standard line length accross the
> > board.
> > 
> > Bruce Richardson (3):
> >   docs: change hardcoded date to auto-generated
> >   docs: adjust line lengths in FreeBSD GSG rst files
> >   docs: update FreeBSD GSG to document ports install
> >
> Hi Thomas,
> 
> is there some restriction on character encoding in emails? I see that only the
> first of my three patches made it through, and I suspect that the presence of the
> (R) symbol [as in Intel(R) DPDK] may have prevented the other patches from 
> getting through.

I'm not aware of such restriction and I have no trace of your emails.
Are you sure they are not blocked earlier?

-- 
Thomas

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8
  2014-11-24 15:25   ` Thomas Monjalon
@ 2014-11-24 15:45     ` Bruce Richardson
  0 siblings, 0 replies; 13+ messages in thread
From: Bruce Richardson @ 2014-11-24 15:45 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

On Mon, Nov 24, 2014 at 04:25:05PM +0100, Thomas Monjalon wrote:
> 2014-11-24 14:43, Bruce Richardson:
> > On Mon, Nov 24, 2014 at 02:23:51PM +0000, Bruce Richardson wrote:
> > > This patch set updates the FreeBSD GSG for 1.8, mainly by
> > > reworking the document to have installation via the ports
> > > collection as the recommended installation path. Other
> > > adjustments in the set involve updating all docs to use
> > > an auto-generated, rather than hard-coded date, and to have
> > > the FreeBSD GSG use a fairly standard line length accross the
> > > board.
> > > 
> > > Bruce Richardson (3):
> > >   docs: change hardcoded date to auto-generated
> > >   docs: adjust line lengths in FreeBSD GSG rst files
> > >   docs: update FreeBSD GSG to document ports install
> > >
> > Hi Thomas,
> > 
> > is there some restriction on character encoding in emails? I see that only the
> > first of my three patches made it through, and I suspect that the presence of the
> > (R) symbol [as in Intel(R) DPDK] may have prevented the other patches from 
> > getting through.
> 
> I'm not aware of such restriction and I have no trace of your emails.
> Are you sure they are not blocked earlier?
>
They could be, I'll check it out.

/Bruce

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
  2014-11-24 14:23 [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
  2014-11-24 14:23 ` [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated Bruce Richardson
  2014-11-24 14:43 ` [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
@ 2014-11-24 15:48 ` Bruce Richardson
  2014-11-26 10:42   ` Iremonger, Bernard
  2014-12-03 13:23   ` Thomas Monjalon
  2014-11-24 15:50 ` [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install Bruce Richardson
  3 siblings, 2 replies; 13+ messages in thread
From: Bruce Richardson @ 2014-11-24 15:48 UTC (permalink / raw)
  To: bruce.richardson, dev

The FreeBSD GSG rst files had very inconsistent line lengths for text
within paragraph blocks. Sometimes a line would be very short, while often
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 <bruce.richardson@intel.com>
---
 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_gsg/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:
 
 *   TOOLCHAIN is: gcc
 
-The configuration files for the Intel® DPDK targets can be found in the DPDK/config directory in the form of:
+The configuration files for the Intel® DPDK targets can be found in the DPDK/config
+directory in the form of:
 
 ::
 
@@ -79,10 +80,10 @@ The configuration files for the Intel® DPDK targets can be found in the DPDK/co
 .. note::
 
     Configuration files are provided with the RTE_MACHINE optimization level 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® 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 platform
+    on which it is built.  For more information on this setting, and its
+    possible values, see the *Intel® DPDK Programmers Guide*.
 
 To install and make the target, use gmake install T=<target> CC=gcc48.
 
@@ -92,9 +93,8 @@ For example to compile for FreeBSD* use:
 
     gmake install T=x86_64-native-bsdapp-gcc CC=gcc48
 
-To prepare a target without building it, for example,
-if the configuration changes need to be made before compilation,
-use the gmake config T=<target> command:
+To prepare a target without building it, for example, if the configuration
+changes need to be made before compilation, use the gmake config T=<target> command:
 
 .. code-block:: console
 
@@ -106,13 +106,14 @@ To build after configuration, change directory to ./x86_64-native-bsdapp-gcc and
 
     gmake CC=gcc48
 
-Browsing the Installed Intel®DPDK Environment Target
-----------------------------------------------------
+Browsing the Installed Intel® DPDK Environment Target
+-----------------------------------------------------
 
-Once a target is created, it contains all the libraries
-and header files for the Intel® 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 install:
+Once a target is created, it contains all the libraries and header files for the
+Intel® 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 install:
 
 .. code-block:: console
 
@@ -122,17 +123,19 @@ A kmod directory is also present that contains the kernel modules to install:
 Loading the Intel® DPDK contigmem Module
 ----------------------------------------
 
-To run any Intel® DPDK application, the contigmem module must be loaded into the running kernel.
-The module is found in the kmod sub-directory of the Intel® DPDK target directory.
-The module can be loaded using kldload (assuming that the current directory is the Intel® DPDK target directory):
+To run any Intel® DPDK application, the contigmem module must be loaded into the
+running kernel. The module is found in the kmod sub-directory of the Intel® DPDK
+target directory. The module can be loaded using kldload (assuming that the
+current directory is the Intel® DPDK target directory):
 
 .. code-block:: console
 
     kldload ./kmod/contigmem.ko
 
-It is advisable to include the loading of the contigmem module during the 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:
+It is advisable to include the loading of the contigmem module during the 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:
 
 ::
 
@@ -140,11 +143,13 @@ This can be achieved by copying the module to the /boot/kernel/ directory and pl
 
 .. note::
 
-    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.
+    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.
 
-An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/contigmem.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/contigmem.ko:
+Exec format error, is generally attributed to not having enough contiguous memory
+available and can be verified via dmesg or /var/log/messages:
 
 .. code-block:: console
 
@@ -155,8 +160,10 @@ To avoid this error, reduce the number of buffers or the buffer size.
 Loading the Intel® DPDK nic_uio Module
 --------------------------------------
 
-After loading the contigmem module, the nic_uio must also be loaded into the running kernel prior to running any Intel® DPDK application.
-This module must be loaded using the kldload command as shown below (assuming that the current directory is the Intel® DPDK target directory).
+After loading the contigmem module, the nic_uio must also be loaded into the
+running kernel prior to running any Intel® DPDK application.  This module must
+be loaded using the kldload command as shown below (assuming that the current
+directory is the Intel® DPDK target directory).
 
 .. code-block:: console
 
@@ -164,12 +171,13 @@ This module must be loaded using the kldload command as shown below (assuming th
 
 .. note::
 
-    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 only 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 <module_name>.
+    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 necessary to
+    load nic_uio after booting into the kernel, specifically after the original
+    driver has been loaded.
 
 To load the module during boot, copy the nic_uio module to /boot/kernel and place the following into /boot/loader.conf:
 
@@ -184,8 +192,8 @@ To load the module during boot, copy the nic_uio module to /boot/kernel and plac
 Binding Network Ports to the nic_uio Module
 -------------------------------------------
 
-By default, the nic_uio module will take ownership of network ports if they are recognized Intel® DPDK devices
-and are not owned by another module.
+By default, the nic_uio module will take ownership of network ports if they are
+recognized Intel® DPDK devices and are not owned by another module.
 
 Device ownership can be viewed using the pciconf -l command.
 
@@ -209,45 +217,53 @@ The first column constitutes three components:
 
 Where no driver is associated with a device, the device name will be none.
 
-By default, the FreeBSD* kernel will include built-in drivers for the most 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 most common
+devices; a kernel rebuild would normally be required to either remove the drivers
+or configure them as loadable modules.
 
-To avoid building a custom kernel, the nic_uio module can detach a network 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:
+To avoid building a custom kernel, the nic_uio module can detach a network 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:
 
 ::
 
     hw.nic_uio.bdfs="b:d:f,b:d:f,..."
 
-Where a comma separated list of selectors is set, the list must not contain any whitespace.
+Where a comma separated list of selectors is set, the list must not contain any
+whitespace.
 
-For example to re-bind ix2@pci0:2:0:0 and ix3@pci0:2:0: to the nic_uio module 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 module
+upon loading, use the following command:
 
 .. code-block:: console
 
     kenv hw.nic_uio.bdfs="2:0:0,2:0:1"
 
-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:
 
 ::
 
     hw.nic_uio.bdfs="2:0:0,2:0:1"
 
-To restore the original device binding,
-it is necessary to reboot FreeBSD* if the original driver has been compiled into the kernel.
+To restore the original device binding, it is necessary to reboot FreeBSD* if the
+original driver has been compiled into the kernel.
 
 For example to rebind some or all ports to the original driver:
 
-Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if specified there for persistency, then;
+Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if specified there
+for persistency, then;
 
 .. code-block:: console
 
     reboot
 
-If rebinding to a driver that is a loadable module, the network port binding can be reset without rebooting.
-This requires the unloading of the nic_uio module and the original driver.
+If rebinding to a driver that is a loadable module, the network port binding can
+be reset without rebooting.  This requires the unloading of the nic_uio module
+and the original driver.
 
-Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if specified there for persistency.
+Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if specified
+there for persistency.
 
 .. code-block:: console
 
diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_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
 =========================================
 
-The chapter describes how to compile and run applications in an Intel® 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® DPDK
+environment. It also provides a pointer to where sample applications are stored.
 
 Compiling a Sample Application
 ------------------------------
 
-Once an Intel® 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 application.
+Once an Intel® 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 application.
 
 When compiling an application in the FreeBSD* environment on the Intel® DPDK,
 the following variables must be exported:
@@ -48,15 +49,15 @@ the following variables must be exported:
 *   RTE_TARGET - Points to the Intel® DPDK target environment directory.
     For FreeBSD*, this is the x86_64-native-bsdapp-gcc directory.
 
-The following is an example of creating the helloworld application,
-which runs in the Intel® DPDK FreeBSD* environment.
-This example may be found in the ${RTE_SDK}/examples directory.
+The following is an example of creating the helloworld application, which runs
+in the Intel® DPDK FreeBSD* environment. This example may be found in the
+${RTE_SDK}/examples directory.
 
-The directory contains the main.c file.
-This file, when combined with the libraries in the Intel® DPDK target environment,
-calls the various functions to initialize the Intel® DPDK environment,
-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 the
+libraries in the Intel® DPDK target environment, calls the various functions to
+initialize the Intel® DPDK environment, then launches an entry point (dispatch
+application) for each core to be utilized.  By default, the binary is generated
+in the build directory.
 
 .. code-block:: console
 
@@ -73,9 +74,11 @@ By default, the binary is generated in the build directory.
 
 .. note::
 
-    In the above example, helloworld was in the directory structure of the Intel® DPDK.
-    However, it could have been located outside the directory structure to keep the Intel® 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 the
+    Intel® DPDK.  However, it could have been located outside the directory
+    structure to keep the Intel® DPDK structure intact.  In the following case,
+    the helloworld application is copied to a new directory as a new starting
+    point.
 
 .. code-block:: console
 
@@ -96,8 +99,9 @@ Running a Sample Application
 
 #.  Any ports to be used by the application must be already bound to the nic_uio module,
     as described in section Section 3.6, “ , ” prior to running the application.
-    The application is linked with the Intel® DPDK target environment's Environment Abstraction Layer (EAL) library,
-    which provides some options that are generic to every Intel® DPDK application.
+    The application is linked with the Intel® DPDK target environment's Environment
+    Abstraction Layer (EAL) library, which provides some options that are generic
+    to every Intel® DPDK application.
 
 The following is the list of options that can be given to the EAL:
 
@@ -107,25 +111,27 @@ The following is the list of options that can be given to the EAL:
 
 .. note::
 
-    EAL has a common interface between all operating systems and is based 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.
+    EAL has a common interface between all operating systems and is based 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.
 
 The EAL options for FreeBSD* are as follows:
 
 *   -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 numbering
+    can change between platforms and should be determined beforehand.
 
 *   -n NUM
     : Number of memory channels per processor socket.
 
 *   -b <domain:bus:devid.func>
-    : 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).
 
 *   --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.
 
 *   -r NUM
     : Number of memory ranks.
@@ -153,9 +159,9 @@ Other options, specific to Linux* and are not supported under FreeBSD* are as fo
 
 The -c and the -n options are mandatory; the others are optional.
 
-Copy the Intel® DPDK application binary to your target,
-then run the application as follows (assuming the platform has four memory channels,
-and that cores 0-3 are present and are to be used for running the application):
+Copy the Intel® DPDK application binary to your target, then run the application
+as follows (assuming the platform has four memory channels, and that cores 0-3
+are present and are to be used for running the application):
 
 .. code-block:: console
 
@@ -163,18 +169,20 @@ and that cores 0-3 are present and are to be used for running the application):
 
 .. note::
 
-    The --proc-type and --file-prefix EAL options are used for running multiple Intel® DPDK processes.
-    See the “Multi-process Sample Application” chapter in the
-    *Intel® DPDK Sample Applications User Guide and the Intel® DPDK Programmers Guide* for more details.
+    The --proc-type and --file-prefix EAL options are used for running multiple
+    Intel® DPDK processes.  See the “Multi-process Sample Application” chapter
+    in the *Intel® DPDK Sample Applications User Guide and the Intel® DPDK
+    Programmers Guide* for more details.
 
 Running Intel®DPDK Applications Without Root Privileges
 -------------------------------------------------------
 
-Although applications using the Intel® DPDK use network ports and other hardware resources directly,
-with a number of small permission adjustments,
-it is possible to run these applications as a user other than “root”.
-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® DPDK application has access to them:
+Although applications using the Intel® DPDK use network ports and other hardware
+resources directly, with a number of small permission adjustments, it is possible
+to run these applications as a user other than “root”.  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® DPDK application has access
+to them:
 
 *   The userspace-io device files in /dev, for example, /dev/uio0, /dev/uio1, and so on
 
diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst
index bb19615..fc27ed0 100644
--- a/doc/guides/freebsd_gsg/intro.rst
+++ b/doc/guides/freebsd_gsg/intro.rst
@@ -31,12 +31,14 @@
 Introduction
 ============
 
-This document contains instructions for installing and configuring the Intel® Data Plane Development Kit(Intel® DPDK) software.
-It is designed to get customers up and running quickly.
-The document describes how to compile and run an Intel® DPDK application in a FreeBSD* application (bsdapp) environment,
-without going deeply into detail.
+This document contains instructions for installing and configuring the Intel®
+Data Plane Development Kit(Intel® DPDK) software.  It is designed to get customers
+up and running quickly.  The document describes how to compile and run an Intel®
+DPDK application in a FreeBSD* application (bsdapp) environment, without going
+deeply into detail.
 
-For a comprehensive guide to installing and using FreeBSD*, the following handbook is available from the FreeBSD* Documentation Project:
+For a comprehensive guide to installing and using FreeBSD*, the following
+handbook is available from the FreeBSD* Documentation Project:
 
 `http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_
 
@@ -45,30 +47,36 @@ DocumentationRoadmap
 
 The following is a list of Intel® DPDK documents in the suggested reading order:
 
-*   **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.
+*   **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.
 
-*   **Getting Started Guide** (this document): Describes how to install and configure the Intel® 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® DPDK; designed to get users up and running quickly with the
+    software.
 
 *   **Programmer's Guide**: Describes:
 
-    *   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
 
-    *   The content of the Intel® DPDK, the build system
-        (including the commands that can be used in the root Intel® DPDK Makefile to build the development kit and an application)
-        and guidelines for porting an application
+    *   The content of the Intel® DPDK, the build system (including the commands
+        that can be used in the root Intel® DPDK Makefile to build the development
+        kit and an application) and guidelines for porting an application
 
-    *   Optimizations used in the software and those that should be considered for new development
+    *   Optimizations used in the software and those that should be considered
+        for new development
 
     A glossary of terms is also provided.
 
-*   **API Reference**: Provides detailed information about Intel® DPDK functions, data structures and other programming constructs.
+*   **API Reference**: Provides detailed information about Intel® DPDK functions,
+    data structures and other programming constructs.
 
 *   **Sample Applications User Guide**: Describes a set of sample applications.
-    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.
 
 .. note::
 
-    These documents are available for download as a separate documentation package at the same location as the Intel® DPDK code package.
+    These documents are available for download as a separate documentation
+    package at the same location as the Intel® 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® DPDK
 .. note::
 
     The Intel® DPDK and its applications requires the GNU make system (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.
 
 **Required Tools:**
 
 .. note::
 
-    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® DPDK also requires the use of FreeBSD* ports to compile and function.
+    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®
+    DPDK also requires the use of FreeBSD* ports to compile and function.
 
-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 the FreeBSD*
+ports tree by issuing the following commands:
 
 .. code-block:: console
 
     root@host:~ # portsnap fetch
     root@host:~ # portsnap extract
 
-If the environment requires proxies for external communication, these can be set using:
+If the environment requires proxies for external communication, these can be set
+using:
 
 .. code-block:: console
 
@@ -107,8 +108,8 @@ The ports required and their locations are as follows:
 
 *   /usr/src/contrib/libexecinfo
 
-When running the make config-recursive command, a dialog may be presented to the user.
-For the installation of the Intel® DPDK, the default options were used.
+When running the make config-recursive command, a dialog may be presented to the
+user. For the installation of the Intel® DPDK, the default options were used.
 
 .. note::
 
@@ -120,24 +121,24 @@ Running Intel® DPDK Applications
 --------------------------------
 
 To run an Intel® DPDK application, physically contiguous memory is required.
-In the absence of non-transparent superpages,
-the included sources for the contigmem kernel module provides the ability to
-present contiguous blocks of memory for the Intel® DPDK to use.
-Section 3.4, “Loading the Intel® DPDK contigmem Module” on page 8
-for details on the loading of this module.
+In the absence of non-transparent superpages, the included sources for the
+contigmem kernel module provides the ability to present contiguous blocks of
+memory for the Intel® DPDK to use.  Section 3.4, “Loading the Intel® DPDK
+Contigmem Module” on page 8 for details on the loading of this module.
 
-Using Intel® DPDK contigmem Module
+Using Intel® DPDK Contigmem Module
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The amount of physically contiguous memory along with the number of physically contiguous blocks
-can be set at runtime and prior to module loading using:
+The amount of physically contiguous memory along with the number of physically
+contiguous blocks can be set at runtime and prior to module loading using:
 
 .. code-block:: console
 
     root@host:~ # kenv hw.contigmem.num_buffers=n
     root@host:~ # kenv hw.contigmem.buffer_size=m
 
-The kernel environment variables can also be specified during boot by placing the following in /boot/loader.conf:
+The kernel environment variables can also be specified during boot by placing the
+following in /boot/loader.conf:
 
 ::
 
@@ -149,9 +150,9 @@ The variables can be inspected using the following command:
 
     root@host:~ # sysctl -a hw.contigmem
 
-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 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 environment.
 
 .. note::
 
-- 
1.9.3

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install
  2014-11-24 14:23 [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
                   ` (2 preceding siblings ...)
  2014-11-24 15:48 ` [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Bruce Richardson
@ 2014-11-24 15:50 ` Bruce Richardson
  2014-11-26 10:44   ` Iremonger, Bernard
  3 siblings, 1 reply; 13+ messages in thread
From: Bruce Richardson @ 2014-11-24 15:50 UTC (permalink / raw)
  To: bruce.richardson, dev

Since the DPDK is now part of the BSD ports collection, we should
recommend installing from ports as the best way to get it up and
running.
In order to achieve this, while still keeping the document readable, the
chapter on system requirements has been moved to instead be a section
within the chapter on compiling the DPDK outside of the ports
collection. This move is necessary, since it covered a lot of detail on
installing other ports required to build DPDK. These steps are not
needed when installing DPDK itself from ports.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/freebsd_gsg/build_dpdk.rst         | 243 +++++++++++++++++++-------
 doc/guides/freebsd_gsg/build_sample_apps.rst  |  24 ++-
 doc/guides/freebsd_gsg/index.rst              |   2 +-
 doc/guides/freebsd_gsg/install_from_ports.rst | 162 +++++++++++++++++
 doc/guides/freebsd_gsg/intro.rst              |  13 +-
 doc/guides/freebsd_gsg/sys_reqs.rst           | 164 -----------------
 6 files changed, 366 insertions(+), 242 deletions(-)
 create mode 100644 doc/guides/freebsd_gsg/install_from_ports.rst
 delete mode 100644 doc/guides/freebsd_gsg/sys_reqs.rst

diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst
index 8f72a5e..5fdab44 100644
--- a/doc/guides/freebsd_gsg/build_dpdk.rst
+++ b/doc/guides/freebsd_gsg/build_dpdk.rst
@@ -28,9 +28,92 @@
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+.. _building_from_source:
+
 Compiling the Intel® DPDK Target from Source
 ============================================
 
+.. note::
+
+    Testing has been performed using 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® DPDK also requires the use of FreeBSD*
+    ports to compile and function.
+
+System Requirements
+-------------------
+
+The Intel® DPDK and its applications require the GNU make system (gmake)
+to build on FreeBSD*. Optionally, gcc may also be used in place of clang
+to build the Intel® DPDK, in which case it too must be installed prior to
+compiling the Intel® DPDK. The installation of these tools is covered in this
+section.
+
+Compiling the Intel® DPDK requires the FreeBSD kernel sources, which should be
+included during the installation of FreeBSD* on the development platform.
+The Intel® DPDK also requires the use of FreeBSD* ports to compile and function.
+
+To use the FreeBSD* ports system, it is required to update and extract the FreeBSD*
+ports tree by issuing the following commands:
+
+.. code-block:: console
+
+    root@host:~ # portsnap fetch
+    root@host:~ # portsnap extract
+
+If the environment requires proxies for external communication, these can be set
+using:
+
+.. code-block:: console
+
+    root@host:~ # setenv http_proxy <my_proxy_host>:<port>
+    root@host:~ # setenv ftp_proxy <my_proxy_host>:<port>
+
+The FreeBSD* ports below need to be installed prior to building the Intel® DPDK.
+In general these can be installed using the following set of commands:
+
+#.  cd /usr/ports/<port_location>
+
+#.  make config-recursive
+
+#.  make install
+
+#.  make clean
+
+Each port location can be found using:
+
+.. code-block:: console
+
+    user@host:~ # whereis <port_name>
+
+The ports required and their locations are as follows:
+
+dialog4ports
+   /usr/ports/ports-mgmt/dialog4ports
+
+GNU make(gmake)
+   /usr/ports/devel/gmake
+
+coreutils
+   /usr/ports/sysutils/coreutils
+
+For compiling and using the Intel® DPDK with gcc, it too must be installed
+from the ports collection:
+
+gcc: version 4.8 is recommended
+   /usr/ports/lang/gcc48
+   (Ensure that CPU_OPTS is selected (default is OFF))
+
+When running the make config-recursive command, a dialog may be presented to the
+user. For the installation of the Intel® DPDK, the default options were used.
+
+.. note::
+
+    To avoid multiple dialogs being presented to the user during make install,
+    it is advisable before running the make install command to re-run the
+    make config -recursive command until no more dialogs are seen.
+
+
 Install the Intel® DPDK and Browse Sources
 ------------------------------------------
 
@@ -68,7 +151,7 @@ Where:
 
 *   EXECENV is: bsdapp
 
-*   TOOLCHAIN is: gcc
+*   TOOLCHAIN is: gcc | clang
 
 The configuration files for the Intel® DPDK targets can be found in the DPDK/config
 directory in the form of:
@@ -85,26 +168,20 @@ directory in the form of:
     on which it is built.  For more information on this setting, and its
     possible values, see the *Intel® DPDK Programmers Guide*.
 
-To install and make the target, use gmake install T=<target> CC=gcc48.
+To install and make the target, use "gmake install T=<target>".
 
 For example to compile for FreeBSD* use:
 
 .. code-block:: console
 
-    gmake install T=x86_64-native-bsdapp-gcc CC=gcc48
-
-To prepare a target without building it, for example, if the configuration
-changes need to be made before compilation, use the gmake config T=<target> command:
-
-.. code-block:: console
-
-    gmake config T=x86_64-native-bsdapp-gcc CC=gcc48
+    gmake install T=x86_64-native-bsdapp-clang
 
-To build after configuration, change directory to ./x86_64-native-bsdapp-gcc and use:
-
-.. code-block:: console
+.. note::
 
-    gmake CC=gcc48
+	If the compiler binary to be used does not correspond to that given in the
+	TOOLCHAIN part of the target, the compiler command may need to be explicitly
+	specified. For example, if compiling for gcc, where the gcc binary is called
+	gcc4.8, the command would need to be "gmake install T=<target> CC=gcc4.8".
 
 Browsing the Installed Intel® DPDK Environment Target
 -----------------------------------------------------
@@ -120,13 +197,47 @@ contains the kernel modules to install:
     user@host:~/DPDK # ls x86_64-native-bsdapp-gcc
     app   build    hostapp    include    kmod    lib    Makefile
 
+
+.. _loading_contigmem:
+
 Loading the Intel® DPDK contigmem Module
 ----------------------------------------
 
-To run any Intel® DPDK application, the contigmem module must be loaded into the
-running kernel. The module is found in the kmod sub-directory of the Intel® DPDK
-target directory. The module can be loaded using kldload (assuming that the
-current directory is the Intel® DPDK target directory):
+To run an Intel® DPDK application, physically contiguous memory is required.
+In the absence of non-transparent superpages, the included sources for the
+contigmem kernel module provides the ability to present contiguous blocks of
+memory for the Intel® DPDK to use. The contigmem module must be loaded into the
+running kernel before any Intel® DPDK is run.  The module is found in the kmod
+sub-directory of the Intel® DPDK target directory.
+
+The amount of physically contiguous memory along with the number of physically
+contiguous blocks to be reserved by the module can be set at runtime prior to
+module loading using:
+
+.. code-block:: console
+
+    root@host:~ # kenv hw.contigmem.num_buffers=n
+    root@host:~ # kenv hw.contigmem.buffer_size=m
+
+The kernel environment variables can also be specified during boot by placing the
+following in /boot/loader.conf:
+
+::
+
+    hw.contigmem.num_buffers=n hw.contigmem.buffer_size=m
+
+The variables can be inspected using the following command:
+
+.. code-block:: console
+
+    root@host:~ # sysctl -a hw.contigmem
+
+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 environment.
+
+The module can then be loaded using kldload (assuming that the current directory
+is the Intel® DPDK target directory):
 
 .. code-block:: console
 
@@ -147,8 +258,13 @@ directory and placing the following into /boot/loader.conf:
     hw.contigmem.num_buffers and hw.contigmem.buffer_size if the default values
     are not to be used.
 
-An error such as kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/contigmem.ko:
-Exec format error, is generally attributed to not having enough contiguous memory
+An error such as:
+
+.. code-block:: console
+
+    kldload: can't load ./x86_64-native-bsdapp-gcc/kmod/contigmem.ko: Exec format error
+
+is generally attributed to not having enough contiguous memory
 available and can be verified via dmesg or /var/log/messages:
 
 .. code-block:: console
@@ -157,6 +273,8 @@ available and can be verified via dmesg or /var/log/messages:
 
 To avoid this error, reduce the number of buffers or the buffer size.
 
+.. _loading_nic_uio:
+
 Loading the Intel® DPDK nic_uio Module
 --------------------------------------
 
@@ -171,15 +289,15 @@ directory is the Intel® DPDK target directory).
 
 .. note::
 
-    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 only 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.
+    If the ports to be used are currently bound to a existing kernel driver
+    then the hw.nic_uio.bdfs sysctl value will need to be set before loading the
+    module. Setting this value is described in the next section below.
+
+Currently loaded modules can be seen by using the "kldstat" command and a module
+can be removed from the running kernel by using "kldunload <module_name>".
 
-To load the module during boot, copy the nic_uio module to /boot/kernel and place the following into /boot/loader.conf:
+To load the module during boot, copy the nic_uio module to /boot/kernel
+and place the following into /boot/loader.conf:
 
 ::
 
@@ -189,15 +307,21 @@ To load the module during boot, copy the nic_uio module to /boot/kernel and plac
 
     nic_uio_load="YES" must appear after the contigmem_load directive, if it exists.
 
-Binding Network Ports to the nic_uio Module
--------------------------------------------
-
 By default, the nic_uio module will take ownership of network ports if they are
-recognized Intel® DPDK devices and are not owned by another module.
+recognized Intel® DPDK devices and are not owned by another module. However, since
+the FreeBSD kernel includes support, either built-in, or via a separate driver
+module, for most network card devices, it is likely that the ports to be used are
+already bound to a driver other than nic_uio. The following sub-section describe
+how to query and modify the device ownership of the ports to be used by
+Intel® DPDK applications.
+
+.. _binding_network_ports:
 
-Device ownership can be viewed using the pciconf -l command.
+Binding Network Ports to the nic_uio Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The example below shows four Intel® 82599 network ports under if_ixgbe module ownership.
+Device ownership can be viewed using the pciconf -l command. The example below shows
+four Intel® 82599 network ports under "if_ixgbe" module ownership.
 
 .. code-block:: console
 
@@ -232,7 +356,7 @@ kernel environment variable prior to loading nic_uio, as follows:
 Where a comma separated list of selectors is set, the list must not contain any
 whitespace.
 
-For example to re-bind ix2@pci0:2:0:0 and ix3@pci0:2:0: to the nic_uio module
+For example to re-bind "ix2\@pci0:2:0:0" and "ix3\@pci0:2:0:1" to the nic_uio module
 upon loading, use the following command:
 
 .. code-block:: console
@@ -240,52 +364,39 @@ upon loading, use the following command:
     kenv hw.nic_uio.bdfs="2:0:0,2:0:1"
 
 The variable can also be specified during boot by placing the following into
-/boot/loader.conf:
+"/boot/loader.conf", before the previously-described "nic_uio_load" line - as
+shown.
 
 ::
 
     hw.nic_uio.bdfs="2:0:0,2:0:1"
+    nic_uio_load="YES"
 
-To restore the original device binding, it is necessary to reboot FreeBSD* if the
-original driver has been compiled into the kernel.
-
-For example to rebind some or all ports to the original driver:
-
-Update or remove the hw.nic_uio.bdfs entry in /boot/loader.conf if specified there
-for persistency, then;
-
-.. code-block:: console
+Binding Network Ports Back to their Original Kernel Driver
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    reboot
+If the original driver for a network port has been compiled into the kernel,
+it is necessary to reboot FreeBSD* to restore the original device binding. Before
+doing so, update or remove the "hw.nic_uio.bdfs" in "/boot/loader.conf".
 
 If rebinding to a driver that is a loadable module, the network port binding can
-be reset without rebooting.  This requires the unloading of the nic_uio module
-and the original driver.
+be reset without rebooting. To do so, unload both the target kernel module and the
+nic_uio module, modify or clear the "hw.nic_uio.bdfs" kernel environment (kenv)
+value, and reload the two drivers - first the original kernel driver, and then
+the nic_uio driver. [The latter does not need to be reloaded unless there are
+ports that are still to be bound to it].
 
-Update or remove the hw.nic_uio.bdfs entry from /boot/loader.conf if specified
-there for persistency.
+Example commands to perform these steps are shown below:
 
 .. code-block:: console
 
     kldunload nic_uio
+    kldunload <original_driver>
 
-kldunload <original_driver>
-
-.. code-block:: console
-
-    kenv -u hw.nic_uio.bdfs
-
-to remove all network ports from nic_uio and undefined this system variable OR
+    kenv -u hw.nic_uio.bdfs  # to clear the value completely
 
-.. code-block:: console
-
-    kenv hw.nic_uio.bdfs="b:d:f,b:d:f,..."
-
-(to update nic_uio ports)
-
-.. code-block:: console
+    kenv hw.nic_uio.bdfs="b:d:f,b:d:f,..." # to update the list of ports to bind
 
     kldload <original_driver>
-    kldload nic_uio
 
-(if updating the list of associated network ports)
+    kldload nic_uio  # optional
diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst
index 3b2d0c1..dd8c974 100644
--- a/doc/guides/freebsd_gsg/build_sample_apps.rst
+++ b/doc/guides/freebsd_gsg/build_sample_apps.rst
@@ -28,6 +28,8 @@
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+.. _compiling_sample_apps:
+
 Compiling and Running Sample Applications
 =========================================
 
@@ -38,7 +40,7 @@ Compiling a Sample Application
 ------------------------------
 
 Once an Intel® DPDK target environment directory has been created (such as
-x86_64-native-bsdapp-gcc), it contains all libraries and header files required
+x86_64-native-bsdapp-clang), it contains all libraries and header files required
 to build an application.
 
 When compiling an application in the FreeBSD* environment on the Intel® DPDK,
@@ -47,10 +49,13 @@ the following variables must be exported:
 *   RTE_SDK - Points to the Intel® DPDK installation directory.
 
 *   RTE_TARGET - Points to the Intel® DPDK target environment directory.
-    For FreeBSD*, this is the x86_64-native-bsdapp-gcc directory.
+    For FreeBSD*, this is the x86_64-native-bsdapp-clang or
+    x86_64-native-bsdapp-gcc directory.
 
 The following is an example of creating the helloworld application, which runs
-in the Intel® DPDK FreeBSD* environment. This example may be found in the
+in the Intel® DPDK FreeBSD* environment. While the example demonstrates compiling
+using gcc version 4.8, compiling with clang will be similar, except that the "CC="
+parameter can probably be omitted. The "helloworld" example may be found in the
 ${RTE_SDK}/examples directory.
 
 The directory contains the main.c file.  This file, when combined with the
@@ -92,13 +97,15 @@ in the build directory.
     INSTALL-APP helloworld
     INSTALL-MAP helloworld.map
 
+.. _running_sample_app:
+
 Running a Sample Application
 ----------------------------
 
 #.  The contigmem and nic_uio modules must be set up prior to running an application.
 
 #.  Any ports to be used by the application must be already bound to the nic_uio module,
-    as described in section Section 3.6, “ , ” prior to running the application.
+    as described in section :ref:`binding_network_ports`, prior to running the application.
     The application is linked with the Intel® DPDK target environment's Environment
     Abstraction Layer (EAL) library, which provides some options that are generic
     to every Intel® DPDK application.
@@ -107,14 +114,13 @@ The following is the list of options that can be given to the EAL:
 
 .. code-block:: console
 
-    ./rte-app -c COREMASK -n NUM [-b <domain:bus:devid.func>] [-m MB] [-r NUM] [-v] [--file-prefix] [--proc-type <primary|secondary|auto>]
+    ./rte-app -c COREMASK -n NUM [-b <domain:bus:devid.func>] [-r NUM] [-v] [--proc-type <primary|secondary|auto>]
 
 .. note::
 
     EAL has a common interface between all operating systems and is based 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.
+    Linux* notation for PCI devices. For example, a FreeBSD* device selector of
+    pci0:2:0:1 is referred to as 02:00.1 in EAL.
 
 The EAL options for FreeBSD* are as follows:
 
@@ -174,6 +180,8 @@ are present and are to be used for running the application):
     in the *Intel® DPDK Sample Applications User Guide and the Intel® DPDK
     Programmers Guide* for more details.
 
+.. _running_non_root:
+
 Running Intel®DPDK Applications Without Root Privileges
 -------------------------------------------------------
 
diff --git a/doc/guides/freebsd_gsg/index.rst b/doc/guides/freebsd_gsg/index.rst
index 90915a8..f84c2f8 100644
--- a/doc/guides/freebsd_gsg/index.rst
+++ b/doc/guides/freebsd_gsg/index.rst
@@ -78,6 +78,6 @@ Copyright © 2014, Intel Corporation. All rights reserved.
     :numbered:
 
     intro
-    sys_reqs
+    install_from_ports
     build_dpdk
     build_sample_apps
diff --git a/doc/guides/freebsd_gsg/install_from_ports.rst b/doc/guides/freebsd_gsg/install_from_ports.rst
new file mode 100644
index 0000000..c946c33
--- /dev/null
+++ b/doc/guides/freebsd_gsg/install_from_ports.rst
@@ -0,0 +1,162 @@
+..  BSD LICENSE
+    Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+.. _install_from_ports:
+
+Installing Intel® DPDK from the Ports Collection
+================================================
+
+The easiest way to get up and running with the Intel® DPDK on FreeBSD is to
+install it from the ports collection. Details of getting and using the ports
+collection are documented in the FreeBSD Handbook at:
+
+	https://www.freebsd.org/doc/handbook/ports-using.html
+
+.. note::
+
+    Testing has been performed using FreeBSD* 10.0-RELEASE (x86_64) and requires the
+    installation of the kernel sources, which should be included during the
+    installation of FreeBSD*.
+
+Installing the Intel® DPDK FreeBSD Port
+---------------------------------------
+
+On a system with the ports collection installed in /usr/ports, the Intel® DPDK
+can be installed using the commands:
+
+.. code-block:: console
+
+    root@host:~ # cd /usr/ports/net/dpdk
+
+    root@host:~ # make install
+
+After the installation of the Intel® DPDK port, instructions will be printed on
+how to install the kernel modules required to use the Intel® DPDK. A more
+complete version of these instructions can be found in the sections
+:ref:`loading_contigmem` and :ref:`loading_nic_uio`. Normally, lines like
+those below would be added to the file "/boot/loader.conf".
+
+.. code-block:: console
+
+    # reserve 2 x 1G blocks of contiguous memory using contigmem driver
+    hw.contigmem.num_buffers=2
+    hw.contigmem.buffer_size=1073741824
+    contigmem_load="YES"
+    # identify NIC devices for Intel® DPDK apps to use and load nic_uio driver
+    hw.nic_uio.bdfs="2:0:0,2:0:1"
+    nic_uio_load="YES"
+
+Compiling and Running the Example Applications
+----------------------------------------------
+
+When the Intel® DPDK has been installed from the ports collection it installs
+its example applications in "/usr/local/share/dpdk/examples" - also accessible via
+symlink as "/usr/local/share/examples/dpdk". These examples can be compiled and
+run as described in :ref:`compiling_sample_apps`. In this case, the required
+environmental variables should be set as below:
+
+* RTE_SDK=/usr/local/share/dpdk
+
+* RTE_TARGET=x86_64-native-bsdapp-clang
+
+.. note::
+
+	To install a copy of the Intel® DPDK compiled using gcc, please download the
+	official Intel® DPDK package from http://dpdk.org/ and install manually using
+	the instructions given in the next chapter, :ref:`building_from_source`
+
+An example application can therefore be copied to a user's home directory and
+compiled and run as below:
+
+.. code-block:: console
+
+    user@host:~$ export RTE_SDK=/usr/local/share/dpdk
+
+    user@host:~$ export RTE_TARGET=x86_64-native-bsdapp-clang
+
+    user@host:~$ cp -r /usr/local/share/dpdk/examples/helloworld .
+
+    user@host:~$ cd helloworld/
+
+    user@host:~/helloworld$ gmake
+      CC main.o
+      LD helloworld
+      INSTALL-APP helloworld
+      INSTALL-MAP helloworld.map
+
+    user@host:~/helloworld$ sudo ./build/helloworld -c F -n 2
+    EAL: Contigmem driver has 2 buffers, each of size 1GB
+    EAL: Sysctl reports 8 cpus
+    EAL: Detected lcore 0
+    EAL: Detected lcore 1
+    EAL: Detected lcore 2
+    EAL: Detected lcore 3
+    EAL: Support maximum 64 logical core(s) by configuration.
+    EAL: Detected 4 lcore(s)
+    EAL: Setting up physically contiguous memory...
+    EAL: Mapped memory segment 1 @ 0x802400000: physaddr:0x40000000, len 1073741824
+    EAL: Mapped memory segment 2 @ 0x842400000: physaddr:0x100000000, len 1073741824
+    EAL: WARNING: clock_gettime cannot use CLOCK_MONOTONIC_RAW and HPET is not available - clock timings may be less accurate.
+    EAL: TSC frequency is ~3569023 KHz
+    EAL: PCI scan found 24 devices
+    EAL: Master core 0 is ready (tid=0x802006400)
+    EAL: Core 1 is ready (tid=0x802006800)
+    EAL: Core 3 is ready (tid=0x802007000)
+    EAL: Core 2 is ready (tid=0x802006c00)
+    EAL: PCI device 0000:01:00.0 on NUMA socket 0
+    EAL:   probe driver: 8086:10fb rte_ixgbe_pmd
+    EAL:   PCI memory mapped at 0x80074a000
+    EAL:   PCI memory mapped at 0x8007ca000
+    EAL: PCI device 0000:01:00.1 on NUMA socket 0
+    EAL:   probe driver: 8086:10fb rte_ixgbe_pmd
+    EAL:   PCI memory mapped at 0x8007ce000
+    EAL:   PCI memory mapped at 0x80084e000
+    EAL: PCI device 0000:02:00.0 on NUMA socket 0
+    EAL:   probe driver: 8086:10fb rte_ixgbe_pmd
+    EAL:   PCI memory mapped at 0x800852000
+    EAL:   PCI memory mapped at 0x8008d2000
+    EAL: PCI device 0000:02:00.1 on NUMA socket 0
+    EAL:   probe driver: 8086:10fb rte_ixgbe_pmd
+    EAL:   PCI memory mapped at 0x801b3f000
+    EAL:   PCI memory mapped at 0x8008d6000
+    hello from core 1
+    hello from core 2
+    hello from core 3
+    hello from core 0
+
+.. note::
+
+	To run an Intel® DPDK process as a non-root user, adjust the permissions on
+	the /dev/contigmem and /dev/uio device nodes as described in section
+	:ref:`running_non_root`
+
+.. note::
+	For an explanation of the command-line parameters that can be passed to an
+	Intel® DPDK application, see section :ref:`running_sample_app`.
diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst
index fc27ed0..59c17cf 100644
--- a/doc/guides/freebsd_gsg/intro.rst
+++ b/doc/guides/freebsd_gsg/intro.rst
@@ -33,7 +33,7 @@ Introduction
 
 This document contains instructions for installing and configuring the Intel®
 Data Plane Development Kit(Intel® DPDK) software.  It is designed to get customers
-up and running quickly.  The document describes how to compile and run an Intel®
+up and running quickly and describes how to compile and run an Intel®
 DPDK application in a FreeBSD* application (bsdapp) environment, without going
 deeply into detail.
 
@@ -42,8 +42,15 @@ handbook is available from the FreeBSD* Documentation Project:
 
 `http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html <http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/index.html>`_
 
-DocumentationRoadmap
---------------------
+.. note::
+
+	The Intel® DPDK is now available as part of the FreeBSD ports collection.
+	Installing via the ports collection infrastructure is now the recommended
+	way to install the Intel® DPDK on FreeBSD, and is documented in the
+	next chapter, :ref:`install_from_ports`.
+
+Documentation Roadmap
+---------------------
 
 The following is a list of Intel® DPDK documents in the suggested reading order:
 
diff --git a/doc/guides/freebsd_gsg/sys_reqs.rst b/doc/guides/freebsd_gsg/sys_reqs.rst
deleted file mode 100644
index 8ce0ba4..0000000
--- a/doc/guides/freebsd_gsg/sys_reqs.rst
+++ /dev/null
@@ -1,164 +0,0 @@
-..  BSD LICENSE
-    Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions
-    are met:
-
-    * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in
-    the documentation and/or other materials provided with the
-    distribution.
-    * Neither the name of Intel Corporation nor the names of its
-    contributors may be used to endorse or promote products derived
-    from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-System Requirements
-===================
-
-This chapter describes the packages required to compile the Intel® DPDK.
-
-Compilationofthe Intel® DPDK
-----------------------------
-
-.. note::
-
-    The Intel® DPDK and its applications requires the GNU make system (gmake)
-    and the GNU Compiler Collection (gcc) to build on FreeBSD*.  The
-    installation of these tools is covered in this section.
-
-**Required Tools:**
-
-.. note::
-
-    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®
-    DPDK also requires the use of FreeBSD* ports to compile and function.
-
-To use the FreeBSD* ports system, it is required to update and extract the FreeBSD*
-ports tree by issuing the following commands:
-
-.. code-block:: console
-
-    root@host:~ # portsnap fetch
-    root@host:~ # portsnap extract
-
-If the environment requires proxies for external communication, these can be set
-using:
-
-.. code-block:: console
-
-    root@host:~ # setenv http_proxy <my_proxy_host>:<port>
-    root@host:~ # setenv ftp_proxy <my_proxy_host>:<port>
-
-The FreeBSD* ports below need to be installed prior to building the Intel® DPDK.
-In general these can be installed using the following set of commands:
-
-#.  cd /usr/ports/<port_location>
-
-#.  make config-recursive
-
-#.  make install
-
-#.  make clean
-
-Each port location can be found using:
-
-.. code-block:: console
-
-    user@host:~ # whereis <port_name>
-
-The ports required and their locations are as follows:
-
-*   dialog4ports
-
-*   /usr/ports/ports-mgmt/dialog4ports
-
-*   gcc: version 4.8 is recommended
-
-*   /usr/ports/lang/gcc48
-
-*   Ensure that CPU_OPTS is selected (default is OFF)
-
-*   GNU make(gmake)
-
-*   Installed automatically with gcc48
-
-*   coreutils
-
-*   /usr/ports/sysutils/coreutils
-
-*   libexecinfo  (Not required for FreeBSD* 10)
-
-*   /usr/src/contrib/libexecinfo
-
-When running the make config-recursive command, a dialog may be presented to the
-user. For the installation of the Intel® DPDK, the default options were used.
-
-.. note::
-
-    To avoid multiple dialogs being presented to the user during make install,
-    it is advisable before running the make install command to re-run the
-    make config -recursive command until no more dialogs are seen.
-
-Running Intel® DPDK Applications
---------------------------------
-
-To run an Intel® DPDK application, physically contiguous memory is required.
-In the absence of non-transparent superpages, the included sources for the
-contigmem kernel module provides the ability to present contiguous blocks of
-memory for the Intel® DPDK to use.  Section 3.4, “Loading the Intel® DPDK
-Contigmem Module” on page 8 for details on the loading of this module.
-
-Using Intel® DPDK Contigmem Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The amount of physically contiguous memory along with the number of physically
-contiguous blocks can be set at runtime and prior to module loading using:
-
-.. code-block:: console
-
-    root@host:~ # kenv hw.contigmem.num_buffers=n
-    root@host:~ # kenv hw.contigmem.buffer_size=m
-
-The kernel environment variables can also be specified during boot by placing the
-following in /boot/loader.conf:
-
-::
-
-    hw.contigmem.num_buffers=n hw.contigmem.buffer_size=m
-
-The variables can be inspected using the following command:
-
-.. code-block:: console
-
-    root@host:~ # sysctl -a hw.contigmem
-
-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 environment.
-
-.. note::
-
-    The /boot/loader.conf file may not exist, but can be created as a root user
-    and should be given permissions as follows:
-
-.. code-block:: console
-
-        root@host:~ # chmod 644 /boot/loader.conf
-- 
1.9.3

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated
  2014-11-24 14:23 ` [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated Bruce Richardson
@ 2014-11-26 10:38   ` Iremonger, Bernard
  0 siblings, 0 replies; 13+ messages in thread
From: Iremonger, Bernard @ 2014-11-26 10:38 UTC (permalink / raw)
  To: Richardson, Bruce; +Cc: dev

> -----Original Message-----
> Subject: [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated
> 
> The index.html file for each of the "guide" docs had a hard-coded date value in them of June 2014.
> Rather than update each of these for each revision, just use the |today| directive to insert the date at
> which the document was generated.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
  2014-11-24 15:48 ` [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Bruce Richardson
@ 2014-11-26 10:42   ` Iremonger, Bernard
  2014-12-03 13:23   ` Thomas Monjalon
  1 sibling, 0 replies; 13+ messages in thread
From: Iremonger, Bernard @ 2014-11-26 10:42 UTC (permalink / raw)
  To: Richardson, Bruce; +Cc: dev

> -----Original Message-----
> Subject: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
> 
> The FreeBSD GSG rst files had very inconsistent line lengths for text within paragraph blocks.
> Sometimes a line would be very short, while often 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 <bruce.richardson@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.


^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install
  2014-11-24 15:50 ` [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install Bruce Richardson
@ 2014-11-26 10:44   ` Iremonger, Bernard
  0 siblings, 0 replies; 13+ messages in thread
From: Iremonger, Bernard @ 2014-11-26 10:44 UTC (permalink / raw)
  To: Richardson, Bruce; +Cc: dev

> -----Original Message-----
> Subject: [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install
> 
> Since the DPDK is now part of the BSD ports collection, we should recommend installing from ports as
> the best way to get it up and running.
> In order to achieve this, while still keeping the document readable, the chapter on system
> requirements has been moved to instead be a section within the chapter on compiling the DPDK
> outside of the ports collection. This move is necessary, since it covered a lot of detail on installing other
> ports required to build DPDK. These steps are not needed when installing DPDK itself from ports.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.


^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
  2014-11-24 15:48 ` [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Bruce Richardson
  2014-11-26 10:42   ` Iremonger, Bernard
@ 2014-12-03 13:23   ` Thomas Monjalon
  2014-12-03 14:54     ` Bruce Richardson
  1 sibling, 1 reply; 13+ messages in thread
From: Thomas Monjalon @ 2014-12-03 13:23 UTC (permalink / raw)
  To: Bruce Richardson; +Cc: dev

2014-11-24 15:48, Bruce Richardson:
> The FreeBSD GSG rst files had very inconsistent line lengths for text
> within paragraph blocks. Sometimes a line would be very short, while often
> 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.

I'm not sure we should be strict with line lengths in the doc.
The most important thing is to limit the wrapping impact of future patches.
Starting a new sentence at the beginning of the line is often a good way
to keep context lines unchanged when updating only one sentence.
Don't forget that a carriage return in rst has no impact on generated doc.

-- 
Thomas

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
  2014-12-03 13:23   ` Thomas Monjalon
@ 2014-12-03 14:54     ` Bruce Richardson
  2014-12-04 11:41       ` Iremonger, Bernard
  0 siblings, 1 reply; 13+ messages in thread
From: Bruce Richardson @ 2014-12-03 14:54 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

On Wed, Dec 03, 2014 at 02:23:44PM +0100, Thomas Monjalon wrote:
> 2014-11-24 15:48, Bruce Richardson:
> > The FreeBSD GSG rst files had very inconsistent line lengths for text
> > within paragraph blocks. Sometimes a line would be very short, while often
> > 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.
> 
> I'm not sure we should be strict with line lengths in the doc.
> The most important thing is to limit the wrapping impact of future patches.
> Starting a new sentence at the beginning of the line is often a good way
> to keep context lines unchanged when updating only one sentence.
> Don't forget that a carriage return in rst has no impact on generated doc.
> 
> -- 
> Thomas

Hi Thomas,
I agree that we shouldn't be strict, but the variance in line length was really
huge, and shorter lines are always easier to read. Even my patch just limited
line length to somethign between 80-90 depending on wording, since a hard-80 I
feel is too extreme.

/Bruce

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
  2014-12-03 14:54     ` Bruce Richardson
@ 2014-12-04 11:41       ` Iremonger, Bernard
  0 siblings, 0 replies; 13+ messages in thread
From: Iremonger, Bernard @ 2014-12-04 11:41 UTC (permalink / raw)
  To: Richardson, Bruce, Thomas Monjalon; +Cc: dev

Hi Bruce, Thomas,

> Subject: Re: [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files
> 
> On Wed, Dec 03, 2014 at 02:23:44PM +0100, Thomas Monjalon wrote:
> > 2014-11-24 15:48, Bruce Richardson:
> > > The FreeBSD GSG rst files had very inconsistent line lengths for
> > > text within paragraph blocks. Sometimes a line would be very short,
> > > while often 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.
> >
> > I'm not sure we should be strict with line lengths in the doc.
> > The most important thing is to limit the wrapping impact of future patches.
> > Starting a new sentence at the beginning of the line is often a good
> > way to keep context lines unchanged when updating only one sentence.
> > Don't forget that a carriage return in rst has no impact on generated doc.
> >
> > --
> > Thomas
> 
> Hi Thomas,
> I agree that we shouldn't be strict, but the variance in line length was really huge, and shorter lines are
> always easier to read. Even my patch just limited line length to somethign between 80-90 depending
> on wording, since a hard-80 I feel is too extreme.
> 
> /Bruce

When converting the documents originally I chose to wrap sentences that were longer than 120-130 characters.
I normally wrapped at a punctuation point for readability. So a long sentence might wrap over several lines.
Sentences shorter than 130 characters were given a separate line.
I don't think there is anything to be gained by reworking the line lengths as it has no effect on the generated  HTML.

Bernard.

^ permalink raw reply	[flat|nested] 13+ messages in thread

end of thread, other threads:[~2014-12-04 11:41 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-11-24 14:23 [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
2014-11-24 14:23 ` [dpdk-dev] [PATCH 1/3] docs: change hardcoded date to auto-generated Bruce Richardson
2014-11-26 10:38   ` Iremonger, Bernard
2014-11-24 14:43 ` [dpdk-dev] [PATCH 0/3] docs: update FreeBSD GSG for 1.8 Bruce Richardson
2014-11-24 15:25   ` Thomas Monjalon
2014-11-24 15:45     ` Bruce Richardson
2014-11-24 15:48 ` [dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files Bruce Richardson
2014-11-26 10:42   ` Iremonger, Bernard
2014-12-03 13:23   ` Thomas Monjalon
2014-12-03 14:54     ` Bruce Richardson
2014-12-04 11:41       ` Iremonger, Bernard
2014-11-24 15:50 ` [dpdk-dev] [PATCH 3/3] docs: update FreeBSD GSG to document ports install Bruce Richardson
2014-11-26 10:44   ` Iremonger, Bernard

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git