d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
releases
numam-dpdk/doc/api/doxy-api.conf.in

123 lines
5.0 KiB
Plaintext
Raw Permalink Normal View History

mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
# SPDX-License-Identifier: BSD-3-Clause
# Copyright 2013-2017 6WIND S.A.
PROJECT_NAME = DPDK
PROJECT_NUMBER = @VERSION@
doc: fix API index With Doxygen 1.8.18, a warning appears when tagging the main markdown header with {#index}. That's why the tag has been removed from the API index in DPDK 20.05. Unfortunately it makes the index page classified as a standard "related page" instead of being the "main page". The tag {#mainpage} could be used instead of {#index}. Another solution, chosen here, is to specify the main page file in the Doxygen configuration with the variable USE_MDFILE_AS_MAINPAGE. Fixes: 76fb8fc486f9 ("doc: fix build with doxygen 1.8.18") Cc: stable@dpdk.org Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Tested-by: David Marchand <david.marchand@redhat.com>
2020-05-26 20:29:20 +00:00
USE_MDFILE_AS_MAINPAGE = @TOPDIR@/doc/api/doxy-api-index.md
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
INPUT = @TOPDIR@/doc/api/doxy-api-index.md \
doc: add vdev doxygen The APIs in the rte_bus_vdev.h file were not part of the API documentation. I added this header file to the doxygen config file with the name vdev. Signed-off-by: Aideen McLoughlin <aideen.mcloughlin@intel.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2019-06-26 15:20:55 +00:00
@TOPDIR@/drivers/bus/vdev \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/crypto/scheduler \
dma/dpaa2: add driver-specific configuration API Add additional PMD APIs for DPAA2 QDMA driver for configuring RBP, Ultra Short format, and Scatter Gather support Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
2022-05-05 09:05:20 +00:00
@TOPDIR@/drivers/dma/dpaa2 \
event/dlb2: add token pop API The PMD uses a public interface to allow applications to control the token pop mode. Supported token pop modes are as follows, and they impact core scheduling affinity for ldb ports. AUTO_POP: Pop the CQ tokens immediately after dequeueing. DELAYED_POP: Pop CQ tokens after (dequeue_depth - 1) events are released. Supported on load-balanced ports only. DEFERRED_POP: Pop the CQ tokens during next dequeue operation. Signed-off-by: Timothy McDaniel <timothy.mcdaniel@intel.com> Reviewed-by: Gage Eads <gage.eads@intel.com>
2020-11-01 23:38:00 +00:00
@TOPDIR@/drivers/event/dlb2 \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/mempool/dpaa2 \
net/ark: switch user data to dynamic mbuf fields The second field of metadata is reserved for user data which was using a deprecated mbuf field. It is moved to dynamic fields in order to allow removal of udata64. The use of meta data must be enabled with a compile-time flag RTE_PMD_ARK_{TX,RX}_USERDATA_ENABLE. User data on Tx and Rx paths can be defined and used separately. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Signed-off-by: Ed Czeck <ed.czeck@atomicrules.com>
2020-10-27 21:01:07 +00:00
@TOPDIR@/drivers/net/ark \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/net/bnxt \
@TOPDIR@/drivers/net/bonding \
net/cnxk: support custom SA index Adding cnxk device driver support to configure custom SA index. Custom SA index can be configured as part of the session create as SPI, and later original SPI can be updated using session update. Signed-off-by: Kiran Kumar K <kirankumark@marvell.com> Acked-by: Ray Kinsella <mdr@ashroe.eu> Acked-by: Jerin Jacob <jerinj@marvell.com>
2022-05-04 05:11:18 +00:00
@TOPDIR@/drivers/net/cnxk \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/net/dpaa \
net/dpaa2: enable optional timestamp in mbuf This patch enables the population of timestamp field in mbuf on packet receive. It may give performance impact on LX2xxx platforms. So, it has been made optional for Lx2xxx platform. One shall call, rte_dpaa2_enable_ts() to enable it. Nothing is required for LS2 and LS1088 platforms. Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com> Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com>
2019-01-11 12:24:30 +00:00
@TOPDIR@/drivers/net/dpaa2 \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/net/i40e \
net/iavf: support flex desc metadata extraction Enable metadata extraction for flexible descriptors in AVF, that would allow network function directly get metadata without additional parsing which would reduce the CPU cost for VFs. The enabling metadata extractions involve the metadata of VLAN/IPv4/IPv6/IPv6-FLOW/TCP/MPLS flexible descriptors, and the VF could negotiate the capability of the flexible descriptor with PF and correspondingly configure the specific offload at receiving queues. Signed-off-by: Jeff Guo <jia.guo@intel.com> Acked-by: Haiyue Wang <haiyue.wang@intel.com>
2020-10-30 08:40:30 +00:00
@TOPDIR@/drivers/net/iavf \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/net/ixgbe \
doc: add mlx5 header to API index The file "rte_pmd_mlx5.h" is used to provide mlx5 PMD specific APIs and it needs to be included in the document generation. Signed-off-by: Bing Zhao <bingz@nvidia.com> Reviewed-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: Ori Kam <orika@nvidia.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
2020-10-30 09:29:22 +00:00
@TOPDIR@/drivers/net/mlx5 \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
@TOPDIR@/drivers/net/softnic \
@TOPDIR@/drivers/raw/dpaa2_cmdif \
raw/ifpga: add FPGA RSU APIs RSU (Remote System Update) depends on secure manager which may be different on various implementations, so a new secure manager device is implemented for adapting such difference. There are five APIs added: 1. rte_pmd_ifpga_get_dev_id() get raw device ID of ifpga device from PCI address like 'Domain:Bus:Dev.Func'. 2. rte_pmd_ifpga_update_flash() update flash with specific image file. 3. rte_pmd_ifpga_stop_update() abort flash update process. 4. rte_pmd_ifpga_reboot_try() check current ifpga status and change it to reboot status if it is idle. 5. rte_pmd_ifpga_reload() trigger full reconfiguration of ifpga device. Signed-off-by: Wei Huang <wei.huang@intel.com> Acked-by: Tianfei Zhang <tianfei.zhang@intel.com> Acked-by: Rosen Xu <rosen.xu@intel.com>
2021-03-03 02:34:29 +00:00
@TOPDIR@/drivers/raw/ifpga \
lib: remove librte_ prefix from directory names There is no reason for the DPDK libraries to all have 'librte_' prefix on the directory names. This prefix makes the directory names longer and also makes it awkward to add features referring to individual libraries in the build - should the lib names be specified with or without the prefix. Therefore, we can just remove the library prefix and use the library's unique name as the directory name, i.e. 'eal' rather than 'librte_eal' Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:30 +00:00
@TOPDIR@/lib/eal/include \
@TOPDIR@/lib/eal/include/generic \
@TOPDIR@/lib/acl \
@TOPDIR@/lib/bbdev \
@TOPDIR@/lib/bitratestats \
@TOPDIR@/lib/bpf \
@TOPDIR@/lib/cfgfile \
@TOPDIR@/lib/cmdline \
@TOPDIR@/lib/compressdev \
@TOPDIR@/lib/cryptodev \
@TOPDIR@/lib/distributor \
dmadev: introduce DMA device library The 'dmadev' is a generic type of DMA device. This patch introduce the 'dmadev' device allocation functions. The infrastructure is prepared to welcome drivers in drivers/dma/ Signed-off-by: Chengwen Feng <fengchengwen@huawei.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Morten Brørup <mb@smartsharesystems.com> Acked-by: Jerin Jacob <jerinj@marvell.com> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com> Reviewed-by: Conor Walsh <conor.walsh@intel.com>
2021-10-13 12:24:55 +00:00
@TOPDIR@/lib/dmadev \
lib: remove librte_ prefix from directory names There is no reason for the DPDK libraries to all have 'librte_' prefix on the directory names. This prefix makes the directory names longer and also makes it awkward to add features referring to individual libraries in the build - should the lib names be specified with or without the prefix. Therefore, we can just remove the library prefix and use the library's unique name as the directory name, i.e. 'eal' rather than 'librte_eal' Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:30 +00:00
@TOPDIR@/lib/efd \
@TOPDIR@/lib/ethdev \
@TOPDIR@/lib/eventdev \
@TOPDIR@/lib/fib \
@TOPDIR@/lib/flow_classify \
gpudev: introduce GPU device class library In heterogeneous computing system, processing is not only in the CPU. Some tasks can be delegated to devices working in parallel. The new library gpudev is for dealing with GPGPU computing devices from a DPDK application running on the CPU. The infrastructure is prepared to welcome drivers in drivers/gpu/. Signed-off-by: Elena Agostini <eagostini@nvidia.com> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
2021-11-08 18:57:57 +00:00
@TOPDIR@/lib/gpudev \
lib: remove librte_ prefix from directory names There is no reason for the DPDK libraries to all have 'librte_' prefix on the directory names. This prefix makes the directory names longer and also makes it awkward to add features referring to individual libraries in the build - should the lib names be specified with or without the prefix. Therefore, we can just remove the library prefix and use the library's unique name as the directory name, i.e. 'eal' rather than 'librte_eal' Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:30 +00:00
@TOPDIR@/lib/graph \
@TOPDIR@/lib/gro \
@TOPDIR@/lib/gso \
@TOPDIR@/lib/hash \
@TOPDIR@/lib/ip_frag \
@TOPDIR@/lib/ipsec \
@TOPDIR@/lib/jobstats \
@TOPDIR@/lib/kni \
@TOPDIR@/lib/kvargs \
@TOPDIR@/lib/latencystats \
@TOPDIR@/lib/lpm \
@TOPDIR@/lib/mbuf \
@TOPDIR@/lib/member \
@TOPDIR@/lib/mempool \
@TOPDIR@/lib/meter \
@TOPDIR@/lib/metrics \
@TOPDIR@/lib/node \
@TOPDIR@/lib/net \
pcapng: add new library for writing pcapng files This is utility library for writing pcapng format files used by Wireshark family of utilities. Older tcpdump also knows how to read (but not write) this format. See https://github.com/pcapng/pcapng/ Signed-off-by: Stephen Hemminger <stephen@networkplumber.org> Acked-by: Reshma Pattan <reshma.pattan@intel.com> Acked-by: Ray Kinsella <mdr@ashroe.eu>
2021-10-20 21:42:26 +00:00
@TOPDIR@/lib/pcapng \
lib: remove librte_ prefix from directory names There is no reason for the DPDK libraries to all have 'librte_' prefix on the directory names. This prefix makes the directory names longer and also makes it awkward to add features referring to individual libraries in the build - should the lib names be specified with or without the prefix. Therefore, we can just remove the library prefix and use the library's unique name as the directory name, i.e. 'eal' rather than 'librte_eal' Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:30 +00:00
@TOPDIR@/lib/pci \
@TOPDIR@/lib/pdump \
@TOPDIR@/lib/pipeline \
@TOPDIR@/lib/port \
@TOPDIR@/lib/power \
@TOPDIR@/lib/rawdev \
@TOPDIR@/lib/rcu \
@TOPDIR@/lib/regexdev \
@TOPDIR@/lib/reorder \
@TOPDIR@/lib/rib \
@TOPDIR@/lib/ring \
@TOPDIR@/lib/sched \
@TOPDIR@/lib/security \
@TOPDIR@/lib/stack \
@TOPDIR@/lib/table \
@TOPDIR@/lib/telemetry \
@TOPDIR@/lib/timer \
@TOPDIR@/lib/vhost
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
INPUT += @API_EXAMPLES@
FILE_PATTERNS = rte_*.h \
cmdline.h
PREDEFINED = __DOXYGEN__ \
eal: fix build with musl In musl libc, cpu_set_t is defined only if _GNU_SOURCE is defined. In case _GNU_SOURCE is undefined, as in eal_common_errno.c, it was not possible to include rte_os.h which uses cpu_set_t. This limitation is removed: if CPU_SETSIZE is not defined, cpu_set_t related definitions and functions are skipped. Note: such definitions are unneeded in eal_common_errno.c. Applications which do not define _GNU_SOURCE may miss cpu_set_t related features on musl. Such case is detected by RTE_HAS_CPUSET being undefined, so functions which depend on rte_cpuset_t will be unavailable. A missing include of fcntl.h is also added. Bugzilla ID: 35 Fixes: 11b57c698005 ("eal: fix error string function") Fixes: 176bb37ca6f3 ("eal: introduce internal wrappers for file operations") Cc: stable@dpdk.org Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Signed-off-by: Natanael Copa <ncopa@alpinelinux.org> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> Acked-by: David Marchand <david.marchand@redhat.com>
2021-02-24 23:21:58 +00:00
RTE_HAS_CPUSET \
VFIO_PRESENT \
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
__attribute__(x)=
OPTIMIZE_OUTPUT_FOR_C = YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
EXTRACT_STATIC = YES
DISTRIBUTE_GROUP_DOC = YES
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_SCOPE_NAMES = YES
doc: add deprecated list in doxygen The option GENERATE_DEPRECATEDLIST will create a page "Deprecated List" in "Related Pages" menu. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-10-18 16:09:16 +00:00
GENERATE_DEPRECATEDLIST = YES
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = YES
doc: simplify CSS customization for Doxygen CSS for API documentation was customized by a shell script modifying the file that Doxygen produces. This way CSS code is kept in a script and an extra build step is added. Move custom style to a plain CSS file. Use Doxygen capability to attach this extra stylesheet. Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
2022-04-06 17:10:10 +00:00
HTML_EXTRA_STYLESHEET = @TOPDIR@/doc/api/custom.css
doc: add search engine for API I modified the API config file to incorporate a search button into the API documentation page. Signed-off-by: Aideen McLoughlin <aideen.mcloughlin@intel.com>
2019-06-27 13:58:19 +00:00
SEARCHENGINE = YES
mk: use templated doxygen config This will allow the same config file to be used from Meson. The result has been verified to be identical via diffoscope. Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:34 +00:00
SORT_MEMBER_DOCS = NO
SOURCE_BROWSER = YES
EXAMPLE_PATH = @TOPDIR@/examples
EXAMPLE_PATTERNS = *.c
EXAMPLE_RECURSIVE = YES
OUTPUT_DIRECTORY = @OUTPUT@
STRIP_FROM_PATH = @STRIP_FROM_PATH@
GENERATE_HTML = YES
HTML_OUTPUT = @HTML_OUTPUT@
GENERATE_LATEX = NO
GENERATE_MAN = NO
doc: disable dot graph in doxygen Ubuntu ships with a patched version of doxygen that enables HAVE_DOT (disabled by default). Enabling this option causes the warning: """ warning: Included by graph for 'rte_common.h' not generated, too many nodes. Consider increasing DOT_GRAPH_MAX_NODES """ This reproduces with doxygen version 1.8.13 and dot - graphviz version 2.40.1 on Ubuntu 18.04. This will force doxygen not to assume that dot (part of Graphviz) is installed, and will result in dot not being used for visualization. If someone still needs to generate the graphs, the following can be considered: - Increase DOT_GRAPH_MAX_NODES to a large value. - Set HAVE_DOT for more powerful graphs. - Set DOT_IMAGE_FORMAT=svg to generate svg images. - Set INTERACTIVE_SVG=YES to allow zooming and panning. See: - http://changelogs.ubuntu.com/changelogs/pool/main/d/doxygen/doxygen_1.8.13-10/changelog - http://www.doxygen.nl/manual/config.html#cfg_have_dot - https://github.com/doxygen/doxygen/issues/7345 Signed-off-by: Ali Alnubani <alialnu@mellanox.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2019-10-23 11:56:09 +00:00
HAVE_DOT = NO
doc: make doxygen comply with meson werror option When the --werror meson build option is set, we can set the WARN_AS_ERRORS doxygen option in the doxygen config flag to get the same behaviour for API doc building as for building the rest of DPDK. This can help catch documentation errors sooner in the development process. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2020-09-29 16:55:02 +00:00
WARN_AS_ERROR = @WARN_AS_ERROR@
Reference in New Issue Copy Permalink