d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: remove references to make from contributing guide

Browse Source 
Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <ciara.power@intel.com>
Signed-off-by: Louise Kilheeney <louise.kilheeney@intel.com>
This commit is contained in:
Ciara Power 2020-10-21 09:17:22 +01:00 committed by Thomas Monjalon
parent 95fcf7bff4
commit 532e4e48ca
3 changed files with 21 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/guides/contributing/design.rst
View File

@ -21,7 +21,7 @@ A file located in a subdir of "linux" is specific to this execution environment.
When absolutely necessary, there are several ways to handle specific code: When absolutely necessary, there are several ways to handle specific code:
* Use a ``#ifdef`` with the CONFIG option in the C code. * Use a ``#ifdef`` with a build definition macro in the C code.
This can be done when the differences are small and they can be embedded in the same C file: This can be done when the differences are small and they can be embedded in the same C file:
.. code-block:: c .. code-block:: c
@ -32,30 +32,25 @@ When absolutely necessary, there are several ways to handle specific code:
titi(); titi();
#endif #endif
* Use the CONFIG option in the Makefile. This is done when the differences are more significant. * Use build definition macros and conditions in the Meson build file. This is done when the differences are more significant.
In this case, the code is split into two separate files that are architecture or environment specific. In this case, the code is split into two separate files that are architecture or environment specific.
This should only apply inside the EAL library. This should only apply inside the EAL library.
.. note::
As in the linux kernel, the ``CONFIG_`` prefix is not used in C code.
This is only needed in Makefiles or shell scripts.
Per Architecture Sources Per Architecture Sources
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
The following config options can be used: The following macro options can be used:
* ``CONFIG_RTE_ARCH`` is a string that contains the name of the architecture. * ``RTE_ARCH`` is a string that contains the name of the architecture.
* ``CONFIG_RTE_ARCH_I686``, ``CONFIG_RTE_ARCH_X86_64``, ``CONFIG_RTE_ARCH_X86_64_32`` or ``CONFIG_RTE_ARCH_PPC_64`` are defined only if we are building for those architectures. * ``RTE_ARCH_I686``, ``RTE_ARCH_X86_64``, ``RTE_ARCH_X86_X32``, ``RTE_ARCH_PPC_64``, ``RTE_ARCH_ARM``, ``RTE_ARCH_ARMv7`` or ``RTE_ARCH_ARM64`` are defined only if we are building for those architectures.
Per Execution Environment Sources Per Execution Environment Sources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following config options can be used: The following macro options can be used:
* ``CONFIG_RTE_EXEC_ENV`` is a string that contains the name of the executive environment. * ``RTE_EXEC_ENV`` is a string that contains the name of the executive environment.
* ``CONFIG_RTE_EXEC_ENV_FREEBSD`` or ``CONFIG_RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment. * ``RTE_EXEC_ENV_FREEBSD``, ``RTE_EXEC_ENV_LINUX`` or ``RTE_EXEC_ENV_WINDOWS`` are defined only if we are building for this execution environment.
Mbuf features Mbuf features
------------- -------------
@ -87,22 +82,14 @@ requirements for preventing ABI changes when implementing statistics.
Mechanism to allow the application to turn library statistics on and off Mechanism to allow the application to turn library statistics on and off
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Each library that maintains statistics counters should provide a single build Having runtime support for enabling/disabling library statistics is recommended,
time flag that decides whether the statistics counter collection is enabled or as build-time options should be avoided. However, if build-time options are used,
not. This flag should be exposed as a variable within the DPDK configuration for example as in the table library, the options can be set using c_args.
file. When this flag is set, all the counters supported by current library are When this flag is set, all the counters supported by current library are
collected for all the instances of every object type provided by the library. collected for all the instances of every object type provided by the library.
When this flag is cleared, none of the counters supported by the current library When this flag is cleared, none of the counters supported by the current library
are collected for any instance of any object type provided by the library: are collected for any instance of any object type provided by the library:
.. code-block:: console
# DPDK file config/common_linux, config/common_freebsd, etc.
CONFIG_RTE_<LIBRARY_NAME>_STATS_COLLECT=y/n
The default value for this DPDK configuration file variable (either "yes" or
"no") is decided by each library.
Prevention of ABI changes due to library statistics support Prevention of ABI changes due to library statistics support
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

31
doc/guides/contributing/documentation.rst
View File

@ -218,25 +218,14 @@ Build commands
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
The documentation is built using the standard DPDK build system. The documentation is built using the standard DPDK build system.
Some examples are shown below:
* Generate all the documentation targets:: To build the documentation::
make doc ninja -C build doc
* Generate the Doxygen API documentation in Html:: See :doc:`../linux_gsg/build_dpdk` for more detail on compiling DPDK with meson.
make doc-api-html The output is generated in the ``build`` directory::
* Generate the guides documentation in Html::
make doc-guides-html
* Generate the guides documentation in Pdf::
make doc-guides-pdf
The output of these commands is generated in the ``build`` directory::
build/doc build/doc
|-- html |-- html
@ -251,10 +240,6 @@ The output of these commands is generated in the ``build`` directory::
Make sure to fix any Sphinx or Doxygen warnings when adding or updating documentation. Make sure to fix any Sphinx or Doxygen warnings when adding or updating documentation.
The documentation output files can be removed as follows::
make doc-clean
Document Guidelines Document Guidelines
------------------- -------------------
@ -304,7 +289,7 @@ Line Length
Long literal command lines can be shown wrapped with backslashes. For Long literal command lines can be shown wrapped with backslashes. For
example:: example::
testpmd -l 2-3 -n 4 \ dpdk-testpmd -l 2-3 -n 4 \
--vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \ --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \
-- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \ -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \
--txd=1024 --rxd=1024 --txd=1024 --rxd=1024
@ -456,7 +441,7 @@ Code and Literal block sections
For long literal lines that exceed that limit try to wrap the text at sensible locations. For long literal lines that exceed that limit try to wrap the text at sensible locations.
For example a long command line could be documented like this and still work if copied directly from the docs:: For example a long command line could be documented like this and still work if copied directly from the docs::
build/app/testpmd -l 0-2 -n3 --vdev=net_pcap0,iface=eth0 \ ./<build_dir>/app/dpdk-testpmd -l 0-2 -n3 --vdev=net_pcap0,iface=eth0 \
--vdev=net_pcap1,iface=eth1 \ --vdev=net_pcap1,iface=eth1 \
-- -i --nb-cores=2 --nb-ports=2 \ -- -i --nb-cores=2 --nb-ports=2 \
--total-num-mbufs=2048 --total-num-mbufs=2048
@ -739,9 +724,5 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati
/** Array of physical page addresses for the mempool buffer. */ /** Array of physical page addresses for the mempool buffer. */
phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT]; phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT];
* Check for Doxygen warnings in new code by checking the API documentation build::
make doc-api-html >/dev/null
* Read the rendered section of the documentation that you have added for correctness, clarity and consistency * Read the rendered section of the documentation that you have added for correctness, clarity and consistency
with the surrounding text. with the surrounding text.

6
doc/guides/contributing/patches.rst
View File

@ -486,9 +486,9 @@ By default, ABI compatibility checks are disabled.
To enable them, a reference version must be selected via the environment To enable them, a reference version must be selected via the environment
variable ``DPDK_ABI_REF_VERSION``. variable ``DPDK_ABI_REF_VERSION``.
The ``devtools/test-build.sh`` and ``devtools/test-meson-builds.sh`` scripts The ``devtools/test-meson-builds.sh`` script then build this reference version
then build this reference version in a temporary directory and store the in a temporary directory and store the results in a subfolder of the current
results in a subfolder of the current working directory. working directory.
The environment variable ``DPDK_ABI_REF_DIR`` can be set so that the results go The environment variable ``DPDK_ABI_REF_DIR`` can be set so that the results go
to a different location. to a different location.