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

104 lines
4.3 KiB
Plaintext
Raw Normal View History

doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
# BSD LICENSE
#
metrics: add information metrics library This patch adds a new information metrics library. This Metrics library implements a mechanism by which producers can publish numeric information for later querying by consumers. Metrics themselves are statistics that are not generated by PMDs, and hence are not reported via ethdev extended statistics. Metric information is populated using a push model, where producers update the values contained within the metric library by calling an update function on the relevant metrics. Consumers receive metric information by querying the central metric data, which is held in shared memory. Signed-off-by: Remy Horton <remy.horton@intel.com>
2017-03-30 21:00:57 +00:00
# Copyright 2013-2017 6WIND S.A.
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
#
# 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 6WIND S.A. 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.
PROJECT_NAME = DPDK
doc: move doxygen files in api subdirectory Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-10-15 19:43:41 +00:00
INPUT = doc/api/doxy-api-index.md \
crypto/scheduler: fix doxygen comments This patch adds the missing doxygen comments and updated inline comments to cryptodev scheduler Fixes: d58a3f312545 ("crypto/scheduler: add documentation") Cc: stable@dpdk.org Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-04-18 11:33:15 +00:00
drivers/crypto/scheduler \
doc: add API documentation for bnxt PMD Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-09-11 16:33:35 +00:00
drivers/net/bnxt \
bond: move to drivers/net/ Move bonded ethdev pmd to drivers/net Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-05-15 15:56:48 +00:00
drivers/net/bonding \
doc: add device specific API Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
2017-01-30 18:27:25 +00:00
drivers/net/i40e \
drivers/net/ixgbe \
net/softnic: add softnic PMD Add SoftNIC PMD to provide SW fall-back for ethdev APIs. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com> Acked-by: Thomas Monjalon <thomas@monjalon.net>
2017-10-10 10:18:14 +00:00
drivers/net/softnic \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_eal/common/include \
eal: split atomic operations to architecture specific This patch first adds architecture specific directories to eal. Then split the atomic operations to architecture specific and generic files. Architecture specific files are put into the corresponding architecture directory and common header are put into generic directory. Update documentation generation with new generic/ directory. Signed-off-by: Chao Zhu <bjzhuc@cn.ibm.com> Signed-off-by: David Marchand <david.marchand@6wind.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-10-28 12:50:48 +00:00
lib/librte_eal/common/include/generic \
acl: new library The ACL library is used to perform an N-tuple search over a set of rules with multiple categories and find the best match for each category. Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> Tested-by: Waterman Cao <waterman.cao@intel.com> Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com> [Thomas: some code-style changes]
2014-06-13 11:26:50 +00:00
lib/librte_acl \
bitrate: add bitrate statistics library This patch adds a library that calculates peak and average data-rate statistics. For ethernet devices. These statistics are reported using the metrics library. Signed-off-by: Remy Horton <remy.horton@intel.com>
2017-03-30 21:00:59 +00:00
lib/librte_bitratestats \
doc: add missing API headers Some libraries were not included in doxygen documentation. Other ones were included but not listed in the index. The malloc library is now included in EAL. The libraries compat and jobstats are added but not doxygen compliant. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-08-11 16:09:44 +00:00
lib/librte_cfgfile \
cmdline: add polling mode This patch adds the ability to process console input in the same thread as packet processing by using poll() function. Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2015-05-13 12:00:01 +00:00
lib/librte_cmdline \
doc: add missing API headers Some libraries were not included in doxygen documentation. Other ones were included but not listed in the index. The malloc library is now included in EAL. The libraries compat and jobstats are added but not doxygen compliant. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-08-11 16:09:44 +00:00
lib/librte_compat \
cryptodev: introduce API and framework for crypto devices This patch contains the initial proposed APIs and device framework for integrating crypto packet processing into DPDK. features include: - Crypto device configuration / management APIs - Definitions of supported cipher algorithms and operations. - Definitions of supported hash/authentication algorithms and operations. - Crypto session management APIs - Crypto operation data structures and APIs allocation of crypto operation structure used to specify the crypto operations to be performed on a particular mbuf. - Extension of mbuf to contain crypto operation data pointer and extra flags. - Burst enqueue / dequeue APIs for processing of crypto operations. Signed-off-by: Des O Dea <des.j.o.dea@intel.com> Signed-off-by: John Griffin <john.griffin@intel.com> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Signed-off-by: Declan Doherty <declan.doherty@intel.com> Acked-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
2015-11-25 13:25:12 +00:00
lib/librte_cryptodev \
distributor: new packet distributor library This adds the code for a new Intel DPDK library for packet distribution. The distributor is a component which is designed to pass packets one-at-a-time to workers, with dynamic load balancing. Using the RSS field in the mbuf as a tag, the distributor tracks what packet tag is being processed by what worker and then ensures that no two packets with the same tag are in-flight simultaneously. Once a tag is not in-flight, then the next packet with that tag will be sent to the next available core. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Neil Horman <nhorman@tuxdriver.com> Tested-by: Waterman Cao <waterman.cao@intel.com> [Thomas: add doxygen @file comment]
2014-05-29 10:12:14 +00:00
lib/librte_distributor \
efd: new Elastic Flow Distributor library Elastic Flow Distributor (EFD) is a distributor library that uses perfect hashing to determine a target/value for a given incoming flow key. It has the following advantages: - First, because it uses perfect hashing, it does not store the key itself and hence lookup performance is not dependent on the key size. - Second, the target/value can be any arbitrary value hence the system designer and/or operator can better optimize service rates and inter-cluster network traffic locating. - Third, since the storage requirement is much smaller than a hash-based flow table (i.e. better fit for CPU cache), EFD can scale to millions of flow keys. Finally, with current optimized library implementation performance is fully scalable with number of CPU cores. Signed-off-by: Byron Marohn <byron.marohn@intel.com> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Signed-off-by: Saikrishna Edupuganti <saikrishna.edupuganti@intel.com> Acked-by: Christian Maciocco <christian.maciocco@intel.com>
2017-01-17 22:23:51 +00:00
lib/librte_efd \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_ether \
eventdev: introduce event driven programming model In a polling model, lcores poll ethdev ports and associated rx queues directly to look for packet. In an event driven model, by contrast, lcores call the scheduler that selects packets for them based on programmer-specified criteria. Eventdev library adds support for event driven programming model, which offer applications automatic multicore scaling, dynamic load balancing, pipelining, packet ingress order maintenance and synchronization services to simplify application packet processing. By introducing event driven programming model, DPDK can support both polling and event driven programming models for packet processing, and applications are free to choose whatever model (or combination of the two) that best suits their needs. This patch adds the eventdev specification header file. Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2016-11-18 02:00:38 +00:00
lib/librte_eventdev \
flow_classify: introduce flow classify library The following APIs's are implemented in the librte_flow_classify library: rte_flow_classifier_create rte_flow_classifier_free rte_flow_classifier_query rte_flow_classify_table_create rte_flow_classify_table_entry_add rte_flow_classify_table_entry_delete The following librte_table API's are used: f_create to create a table. f_add to add a rule to the table. f_del to delete a rule from the table. f_free to free a table f_lookup to match packets with the rules. The library supports counting of IPv4 five tupple packets only, ie IPv4 UDP, TCP and SCTP packets. Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com> Acked-by: Jasvinder Singh <jasvinder.singh@intel.com>
2017-10-24 17:28:00 +00:00
lib/librte_flow_classify \
lib/gro: add Generic Receive Offload API framework Generic Receive Offload (GRO) is a widely used SW-based offloading technique to reduce per-packet processing overhead. It gains performance by reassembling small packets into large ones. This patchset is to support GRO in DPDK. To support GRO, this patch implements a GRO API framework. To enable more flexibility to applications, DPDK GRO is implemented as a user library. Applications explicitly use the GRO library to merge small packets into large ones. DPDK GRO provides two reassembly modes. One is called lightweight mode, the other is called heavyweight mode. If applications want to merge packets in a simple way and the number of packets is relatively small, they can use the lightweight mode. If applications need more fine-grained controls, they can choose the heavyweight mode. rte_gro_reassemble_burst is the main reassembly API which is used in lightweight mode and processes N packets at a time. For applications, performing GRO in lightweight mode is simple. They just need to invoke rte_gro_reassemble_burst. Applications can get GROed packets as soon as rte_gro_reassemble_burst returns. rte_gro_reassemble is the main reassembly API which is used in heavyweight mode and tries to merge N inputted packets with the packets in GRO reassembly tables. For applications, performing GRO in heavyweight mode is relatively complicated. Before performing GRO, applications need to create a GRO context object, which keeps reassembly tables of desired GRO types, by rte_gro_ctx_create. Then applications can use rte_gro_reassemble to merge packets. The GROed packets are in the reassembly tables of the GRO context object. If applications want to get them, applications need to manually flush them by flush API. Signed-off-by: Jiayu Hu <jiayu.hu@intel.com> Reviewed-by: Jianfeng Tan <jianfeng.tan@intel.com>
2017-07-09 05:46:44 +00:00
lib/librte_gro \
gso: add Generic Segmentation Offload API framework Generic Segmentation Offload (GSO) is a SW technique to split large packets into small ones. Akin to TSO, GSO enables applications to operate on large packets, thus reducing per-packet processing overhead. To enable more flexibility to applications, DPDK GSO is implemented as a standalone library. Applications explicitly use the GSO library to segment packets. To segment a packet requires two steps. The first is to set proper flags to mbuf->ol_flags, where the flags are the same as that of TSO. The second is to call the segmentation API, rte_gso_segment(). This patch introduces the GSO API framework to DPDK. rte_gso_segment() splits an input packet into small ones in each invocation. The GSO library refers to these small packets generated by rte_gso_segment() as GSO segments. Each of the newly-created GSO segments is organized as a two-segment MBUF, where the first segment is a standard MBUF, which stores a copy of packet header, and the second is an indirect MBUF which points to a section of data in the input packet. rte_gso_segment() reduces the refcnt of the input packet by 1. Therefore, when all GSO segments are freed, the input packet is freed automatically. Additionally, since each GSO segment has multiple MBUFs (i.e. 2 MBUFs), the driver of the interface which the GSO segments are sent to should support to transmit multi-segment packets. The GSO framework clears the PKT_TX_TCP_SEG flag for both the input packet, and all produced GSO segments in the event of success, since segmentation in hardware is no longer required at that point. Signed-off-by: Jiayu Hu <jiayu.hu@intel.com> Signed-off-by: Mark Kavanagh <mark.b.kavanagh@intel.com> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2017-10-07 14:56:39 +00:00
lib/librte_gso \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_hash \
ip_frag: refactor IPv4 fragmentation into a proper library Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com> [Thomas: add in doxygen] Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-05-28 17:32:36 +00:00
lib/librte_ip_frag \
jobstats: new library This library provide API to measure time spend in particular parts of code and to calculate optimal polling time. To calculate a those statistics application code need to be divided into parts (called jobs) that do something. It is up to application to decide what is considered a job. Series of jobs must be surrounded with the rte_jobstats_context_start() and rte_jobstats_context_finish() calls. After that, jobs might be started. Each job must be surrounded with rte_jobstats_start() and rte_jobstats_finish() calls. After job finishes its execution, period in which it should be called again is adjusted. It might be used to minimize time wasted on unnecessary polls/calls. Adjustment is based on data provided by job itself (ex: number of packets it processed). After all jobs in serie are executed fallowing statistics are updated and might be used by application. Statistics can be reset. Some of provided statistic data: - total/min/max execution - time spent in executing jobs. - total/min/max management - time spent outside execution area. This value might be used to measure overhead of scheduling jobs. This time also contains overhead of rte_jobstats library itself. - number of loops that executed at least one job - executed jobs - time when statistics were reset. Each job provide total/min/max execution time and execution count statistics. Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2015-02-24 16:33:23 +00:00
lib/librte_jobstats \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_kni \
kvargs: add in doc Reference the new library in doxygen. Move also some items from misc to a new basic section. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-02-04 15:11:12 +00:00
lib/librte_kvargs \
latency: added new library for latency stats Add a library designed to calculate latency statistics and report them to the application when queried. The library measures minimum, average and maximum latencies, and jitter in nano seconds. The current implementation supports global latency stats, i.e. per application stats. Signed-off-by: Reshma Pattan <reshma.pattan@intel.com> Signed-off-by: Remy Horton <remy.horton@intel.com> Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
2017-03-30 21:01:01 +00:00
lib/librte_latencystats \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_lpm \
lib/librte_mbuf \
doc: add membership documentation This patch adds the documentation for membership library. Signed-off-by: Yipeng Wang <yipeng1.wang@intel.com> Reviewed-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-10-04 03:12:25 +00:00
lib/librte_member \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_mempool \
lib/librte_meter \
metrics: add information metrics library This patch adds a new information metrics library. This Metrics library implements a mechanism by which producers can publish numeric information for later querying by consumers. Metrics themselves are statistics that are not generated by PMDs, and hence are not reported via ethdev extended statistics. Metric information is populated using a push model, where producers update the values contained within the metric library by calling an update function on the relevant metrics. Consumers receive metric information by querying the central metric data, which is held in shared memory. Signed-off-by: Remy Horton <remy.horton@intel.com>
2017-03-30 21:00:57 +00:00
lib/librte_metrics \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_net \
doc: add pdump library to API doxygen Signed-off-by: Reshma Pattan <reshma.pattan@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-12-01 11:02:10 +00:00
lib/librte_pdump \
pipeline: new packet framework logic The Packet Framework pipeline library provides a standard methodology (logically similar to OpenFlow) for rapid development of complex packet processing pipelines out of ports, tables and actions. A pipeline is constructed by connecting its input ports to its output ports through a chain of lookup tables. As result of lookup operation into the current table, one of the table entries (or the default table entry, in case of lookup miss) is identified to provide the actions to be executed on the current packet and the associated action meta-data. The behavior of user actions is defined through the configurable table action handler, while the reserved actions define the next hop for the current packet (either another table, an output port or packet drop) and are handled transparently by the framework. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com> Acked by: Ivan Boule <ivan.boule@6wind.com>
2014-06-04 18:08:35 +00:00
lib/librte_pipeline \
port: new packet framework API This file defines the port operations that have to be implemented by Packet Framework ports. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com> Acked by: Ivan Boule <ivan.boule@6wind.com>
2014-06-04 18:08:19 +00:00
lib/librte_port \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_power \
doc: add reorder api to doxygen Add missing reorder lirbary directory to doxygen configuration. Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2015-02-20 12:10:51 +00:00
lib/librte_reorder \
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
lib/librte_ring \
lib/librte_sched \
table: new packet framework API This file defines the operations to be implemented by any Packet Framework table. Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com> Acked-by: Pablo de Lara Guarch <pablo.de.lara.guarch@intel.com> Acked by: Ivan Boule <ivan.boule@6wind.com>
2014-06-04 18:08:27 +00:00
lib/librte_table \
vhost: add in doc Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-10-13 17:22:45 +00:00
lib/librte_timer \
lib/librte_vhost
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
FILE_PATTERNS = rte_*.h \
cmdline.h
doc: add mbuf cloning functions in doxygen Some functions are available only if RTE_MBUF_SCATTER_GATHER is enabled. So it must be configured for doxygen parser. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-10-24 08:26:02 +00:00
PREDEFINED = __DOXYGEN__ \
mbuf: clean old refcnt option CONFIG_RTE_MBUF_SCATTER_GATHER was renamed into CONFIG_RTE_MBUF_REFCNT by commit 62814bc2e923 and removed by commit 4769bc5a27cc. Some traces remain because of delayed patches. It can also be removed from doxygen config. It is now poisoned in rte_mbuf.h to warn any misuse. Fixes: d0dff9ba445e ("doc: sample application user guide") Fixes: fc1f2750a3ec ("doc: programmers guide") Fixes: 4769bc5a27cc ("mbuf: remove build option to disable refcnt") Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: Changchun Ouyang <changchun.ouyang@intel.com>
2015-03-31 12:45:06 +00:00
__attribute__(x)=
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
OPTIMIZE_OUTPUT_FOR_C = YES
doc: fix doxygen parsing of __attribute__ Ignore __attribute__ because it was wrongly parsed as an identifier. This configuration is described in http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html Reported-by: Cyril Cressent <cyril.cressent@intel.com> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com>
2013-11-05 11:09:12 +00:00
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
EXTRACT_STATIC = YES
doc: apply one comment to all members of a group A doxygen group begins with /**@{*/ and ends with /**@}*/. By enabling DISTRIBUTE_GROUP_DOC, the first comment is applied to each undocumented member of the group. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
2014-09-17 16:11:12 +00:00
DISTRIBUTE_GROUP_DOC = YES
doc: generate HTML for API with doxygen - add index page - add doxygen configuration for API - add doxygen CSS customization applied by a script - HTML generation via make rules The configuration is splitted in a static file and a make rule in order to dynamically configure output format and path. Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> Acked-by: David Marchand <david.marchand@6wind.com>
2013-04-19 10:34:40 +00:00
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_SCOPE_NAMES = YES
GENERATE_DEPRECATEDLIST = NO
VERBATIM_HEADERS = NO
ALPHABETICAL_INDEX = NO
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = YES
SEARCHENGINE = NO
doc: disable doxygen member sorting Disabled the doxygen option to sort member data so that functions and struct memebers are listed in order of definition in the brief and main sections. Previously they were sorted in the brief section and were in definition order in the main section. Signed-off-by: John McNamara <john.mcnamara@intel.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-04-29 10:47:47 +00:00
SORT_MEMBER_DOCS = NO
doc: link doxygen api to source code Enabled Doxygen option to add links to the source code in documented entities. Signed-off-by: John McNamara <john.mcnamara@intel.com> Acked-by: Siobhan Butler <siobhan.a.butler@intel.com>
2015-04-22 16:10:02 +00:00
SOURCE_BROWSER = YES
doc: link examples to API Enable Doxygen parsing of DPDK example files so that the example code is linked to and from the API docs. This allows the reader to see examples of API usage in context by following a link. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-12-11 13:41:51 +00:00
EXAMPLE_PATH = examples
EXAMPLE_PATTERNS = *.c
EXAMPLE_RECURSIVE = YES
Reference in New Issue Copy Permalink