> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Mario Carrillo
> Sent: Tuesday, December 1, 2015 12:53 AM
> To: dev at dpdk.org
> Cc: Venegas Munoz, Jos C
> Subject: [dpdk-dev] [PATCH v7 11/11] doc: Add information about new
> installation rules
>
> Information about variables and rules behaviour is added to documentation.
Hi,
Thanks for the documentation. Some comments below.
> diff --git a/doc/build-sdk-quick.txt b/doc/build-sdk-quick.txt index
> bf18b48..66f0d0e 100644
> --- a/doc/build-sdk-quick.txt
> +++ b/doc/build-sdk-quick.txt
> @@ -5,10 +5,21 @@ Build commands
> all same as build (default rule)
> build build in a configured directory
> clean remove files but keep configuration
> - install build many targets (wildcard allowed) and install
> in DESTDIR
> + install if T is defined, build a target and install in
> DESTDIR
> + else call install-fhs target
The convention in this file is to use tabs rather than spaces for the first
level indentation. Copy that style at the above and following lines.
> uninstall remove all installed targets
> examples build examples for given targets (T=)
> examples_clean clean examples for given targets (T=)
> +Install commands
> + install if T is defined, build a target and install in
> DESTDIR
> + else call install-fhs target
Same as above, 1 tab instead of spaces at the start of the line, spaces
after that for alignment.
> + install-headers install headers files
> + install-bin install app files a dpdk tools
> + install-lib install libraries
> + install-doc install documentation
> + install-mod install modules
> + install-sdk install headers, makefiles, scripts,examples, tools
> and config files
Typo. Needs space after comma.
> + install-fhs install libraries, modules, app files, nic bind files
> and documentation
Maybe "tools" instead of " nic bind files".
Also, for me, "fhs" isn't clear as an option. Maybe "install-all" instead.
> diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst
> b/doc/guides/freebsd_gsg/build_dpdk.rst
> index 8eff599..72826d0 100644
> --- a/doc/guides/freebsd_gsg/build_dpdk.rst
> +++ b/doc/guides/freebsd_gsg/build_dpdk.rst
> @@ -136,6 +136,46 @@ The DPDK is composed of several directories:
>
> * config, tools, scripts, mk: Framework-related makefiles, scripts and
> configuration
>
> +
> +Build and install DPDK using a file hierarchy
> +---------------------------------------------
> +
> +Following the next steps is possible configure, build and install
> +specific files according to a file hierarchy and a group of variables.
Probably better as something like:
It is possible to configure, build and install specific groups of DPDK files
into a a file hierarchy using the following install commands and variables:
> +
> +.. code-block:: console
> +
> + make config T=<config template>
> + make
> + make <install target>
> +
> ++------------------+-----------------------------------------------------
> ---------------------------+
> +| install target | Description
> |
> ++==================+===================================================
> ++=============================+
> +|install |if T is not defined will call install-fhs install
> |
In general tables should be avoided in the docs. See the Tables section of the
DPDK Documentation guidelines:
http://dpdk.org/doc/guides/contributing/documentation.html#tables
A bullet list would be clear here. Something like:
Where the install options are:
* ``install``
If ``T`` is not defined make will call ``install-fhs``.
* ``install-headers``
Install headers files into ``includedir`` which is defined as
``$(prefix)/include/dpdk``.
* ``install-bin``
Install app files and dpdk tools into ``bindir`` which is defined as
``$(exec_prefix)/bin``.
* ``install-lib``
Install libraries into ``libdir`` which is defined as
``$(exec_prefix)/lib``.
* ``install-doc``
Install documentation into ``docdir`` which is defined as
``$(datarootdir)/doc/dpdk``.
* ``install-mod``
Install modules into ``kerneldir``. If ``RTE_EXEC_ENV`` is ``linuxapp`` then
``kerneldir`` is ``/lib/modules/$(uname -r)/extra/drivers/dpdk`` otherwise
``/boot/modules``.
* ``install-sdk``
Install headers, makefiles, scripts,examples and config files into
``sdkdir`` which is defined as ``$(datarootdir)/dpdk``.
* ``install-fhs``
Install libraries, modules, app files, tools and documentation.
> +prefix=/usr/local, exec_prefix=$(prefix) and
> +datarootdir=$(prefix)/share by default however prefix, exec_prefix,
> datarootdir and all path variables can be overridden furthermore all
> targets can use DESTDIR variable.
This could be reformatted more clearly like the following:
The following defaults apply::
prefix=/usr/local
exec_prefix=$(prefix)
datarootdir=$(prefix)/share
All path variables can be overridden and all targets can use the ``DESTDIR``
variable.
>
> Installation of the DPDK Target Environments
> --------------------------------------------
>
> diff --git a/doc/guides/linux_gsg/build_dpdk.rst
Same comments for the Linux GSG.
John.
--
