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

107 lines
4.6 KiB
Plaintext
Raw 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@
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 \
@TOPDIR@/drivers/mempool/dpaa2 \
@TOPDIR@/drivers/net/bnxt \
@TOPDIR@/drivers/net/bonding \
@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 \
doc: add ice PMD in doxygen Add the doxygen for ice protocol extraction feature APIs. Signed-off-by: Haiyue Wang <haiyue.wang@intel.com> Reviewed-by: Xiaolong Ye <xiaolong.ye@intel.com>
2019-11-08 15:44:35 +00:00
@TOPDIR@/drivers/net/ice \
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 \
@TOPDIR@/drivers/net/softnic \
@TOPDIR@/drivers/raw/dpaa2_cmdif \
@TOPDIR@/drivers/raw/dpaa2_qdma \
eal: move common header files The EAL API (with doxygen documentation) is moved from common/include/ to include/, which makes more clear that it is the global API for all environments and architectures. Note that the arch-specific and OS-specific include files are not in this global include directory, but include/generic/ should cover the doxygen documentation for them. Signed-off-by: Thomas Monjalon <thomas@monjalon.net> Acked-by: David Marchand <david.marchand@redhat.com>
2020-03-27 01:15:38 +00:00
@TOPDIR@/lib/librte_eal/include \
@TOPDIR@/lib/librte_eal/include/generic \
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@/lib/librte_acl \
@TOPDIR@/lib/librte_bbdev \
@TOPDIR@/lib/librte_bitratestats \
@TOPDIR@/lib/librte_bpf \
@TOPDIR@/lib/librte_cfgfile \
@TOPDIR@/lib/librte_cmdline \
@TOPDIR@/lib/librte_compressdev \
@TOPDIR@/lib/librte_cryptodev \
@TOPDIR@/lib/librte_distributor \
@TOPDIR@/lib/librte_efd \
@TOPDIR@/lib/librte_ethdev \
@TOPDIR@/lib/librte_eventdev \
fib: add FIB library Add FIB (Forwarding Information Base) library. This library implements a dataplane structures and algorithms designed for fast longest prefix match. Internally it consists of two parts - RIB (control plane ops) and implementation for the dataplane tasks. Initial version provides two implementations for both IPv4 and IPv6: dummy (uses RIB as a dataplane) and DIR24_8 (same as current LPM) Due to proposed design it allows to extend FIB with new algorithms in future (for example DXR, poptrie, etc). Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
2019-11-01 15:21:38 +00:00
@TOPDIR@/lib/librte_fib \
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@/lib/librte_flow_classify \
@TOPDIR@/lib/librte_gro \
@TOPDIR@/lib/librte_gso \
@TOPDIR@/lib/librte_hash \
@TOPDIR@/lib/librte_ip_frag \
doc: update doxygen for IPsec library Added ipsec API from: - rte_ipsec.h - rte_ipsec_sa.h - rte_ipsec_group.h - rte_ipsec_sad.h Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
2019-10-10 16:52:14 +00:00
@TOPDIR@/lib/librte_ipsec \
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@/lib/librte_jobstats \
@TOPDIR@/lib/librte_kni \
@TOPDIR@/lib/librte_kvargs \
@TOPDIR@/lib/librte_latencystats \
@TOPDIR@/lib/librte_lpm \
@TOPDIR@/lib/librte_mbuf \
@TOPDIR@/lib/librte_member \
@TOPDIR@/lib/librte_mempool \
@TOPDIR@/lib/librte_meter \
@TOPDIR@/lib/librte_metrics \
@TOPDIR@/lib/librte_net \
@TOPDIR@/lib/librte_pci \
@TOPDIR@/lib/librte_pdump \
@TOPDIR@/lib/librte_pipeline \
@TOPDIR@/lib/librte_port \
@TOPDIR@/lib/librte_power \
@TOPDIR@/lib/librte_rawdev \
rcu: add RCU library supporting QSBR mechanism Add RCU library supporting quiescent state based memory reclamation method. This library helps identify the quiescent state of the reader threads so that the writers can free the memory associated with the lock less data structures. Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com> Reviewed-by: Steve Capper <steve.capper@arm.com> Reviewed-by: Gavin Hu <gavin.hu@arm.com> Reviewed-by: Ola Liljedahl <ola.liljedahl@arm.com> Acked-by: Paul E. McKenney <paulmck@linux.ibm.com> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com> Tested-by: Jerin Jacob <jerinj@marvell.com> Tested-by: Ruifeng Wang <ruifeng.wang@arm.com> Tested-by: Hemant Agrawal <hemant.agrawal@nxp.com>
2019-05-01 03:54:16 +00:00
@TOPDIR@/lib/librte_rcu \
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@/lib/librte_reorder \
rib: add RIB library Add RIB (Routing Information Base) library. This library implements an IPv4 routing table optimized for control plane operations. It implements a control plane struct containing routes in a tree and provides fast add/del operations for routes. Also it allows to perform fast subtree traversals (i.e. retrieve existing subroutes for a given prefix). This structure will be used as a control plane helper structure for FIB implementation. Also it might be used standalone in other different places such as bitmaps for example. Internal implementation is level compressed binary trie. Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
2019-11-01 15:21:34 +00:00
@TOPDIR@/lib/librte_rib \
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@/lib/librte_ring \
@TOPDIR@/lib/librte_sched \
@TOPDIR@/lib/librte_security \
stack: introduce stack library The rte_stack library provides an API for configuration and use of a bounded stack of pointers. Push and pop operations are MT-safe, allowing concurrent access, and the interface supports pushing and popping multiple pointers at a time. The library's interface is modeled after another DPDK data structure, rte_ring, and its lock-based implementation is derived from the stack mempool handler. An upcoming commit will migrate the stack mempool handler to rte_stack. Signed-off-by: Gage Eads <gage.eads@intel.com> Reviewed-by: Olivier Matz <olivier.matz@6wind.com> Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
2019-04-03 23:20:13 +00:00
@TOPDIR@/lib/librte_stack \
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@/lib/librte_table \
telemetry: introduce infrastructure This patch adds the infrastructure and initial code for the telemetry library. The telemetry init is registered with eal_init(). We can then check to see if --telemetry was passed as an eal option. If --telemetry was parsed, then we call telemetry init at the end of eal init. Control threads are used to get CPU cycles for telemetry, which are configured in this patch also. Signed-off-by: Ciara Power <ciara.power@intel.com> Signed-off-by: Brian Archbold <brian.archbold@intel.com> Signed-off-by: Kevin Laatz <kevin.laatz@intel.com> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com> Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
2018-10-27 09:17:41 +00:00
@TOPDIR@/lib/librte_telemetry \
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@/lib/librte_timer \
@TOPDIR@/lib/librte_vhost
INPUT += @API_EXAMPLES@
FILE_PATTERNS = rte_*.h \
cmdline.h
PREDEFINED = __DOXYGEN__ \
VFIO_PRESENT \
__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: 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
Reference in New Issue Copy Permalink