From: Thomas Monjalon Date: Wed, 15 Oct 2014 19:43:41 +0000 (+0200) Subject: doc: move doxygen files in api subdirectory X-Git-Tag: spdx-start~10271 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=6b919b0f8c056deb0d3e1a2f7d775008576eddb8;p=dpdk.git doc: move doxygen files in api subdirectory Signed-off-by: Thomas Monjalon --- diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md new file mode 100644 index 0000000000..6958f8f9a3 --- /dev/null +++ b/doc/api/doxy-api-index.md @@ -0,0 +1,137 @@ +API {#index} +=== + + + +There are many libraries, so their headers may be grouped by topics: + +- **device**: + [ethdev] (@ref rte_ethdev.h), + [devargs] (@ref rte_devargs.h), + [bond] (@ref rte_eth_bond.h), + [vhost] (@ref rte_virtio_net.h), + [KNI] (@ref rte_kni.h), + [PCI] (@ref rte_pci.h), + [PCI IDs] (@ref rte_pci_dev_ids.h) + +- **memory**: + [memseg] (@ref rte_memory.h), + [memzone] (@ref rte_memzone.h), + [mempool] (@ref rte_mempool.h), + [malloc] (@ref rte_malloc.h), + [memcpy] (@ref rte_memcpy.h) + +- **timers**: + [cycles] (@ref rte_cycles.h), + [timer] (@ref rte_timer.h), + [alarm] (@ref rte_alarm.h) + +- **locks**: + [atomic] (@ref rte_atomic.h), + [rwlock] (@ref rte_rwlock.h), + [spinlock] (@ref rte_spinlock.h) + +- **CPU arch**: + [branch prediction] (@ref rte_branch_prediction.h), + [cache prefetch] (@ref rte_prefetch.h), + [byte order] (@ref rte_byteorder.h), + [CPU flags] (@ref rte_cpuflags.h) + +- **CPU multicore**: + [interrupts] (@ref rte_interrupts.h), + [launch] (@ref rte_launch.h), + [lcore] (@ref rte_lcore.h), + [per-lcore] (@ref rte_per_lcore.h), + [power/freq] (@ref rte_power.h) + +- **layers**: + [ethernet] (@ref rte_ether.h), + [IP] (@ref rte_ip.h), + [SCTP] (@ref rte_sctp.h), + [TCP] (@ref rte_tcp.h), + [UDP] (@ref rte_udp.h), + [frag/reass] (@ref rte_ip_frag.h), + [LPM route] (@ref rte_lpm.h), + [ACL] (@ref rte_acl.h) + +- **QoS**: + [metering] (@ref rte_meter.h), + [scheduler] (@ref rte_sched.h), + [RED congestion] (@ref rte_red.h) + +- **hashes**: + [hash] (@ref rte_hash.h), + [jhash] (@ref rte_jhash.h), + [FBK hash] (@ref rte_fbk_hash.h), + [CRC hash] (@ref rte_hash_crc.h) + +- **containers**: + [mbuf] (@ref rte_mbuf.h), + [ring] (@ref rte_ring.h), + [distributor] (@ref rte_distributor.h), + [tailq] (@ref rte_tailq.h), + [bitmap] (@ref rte_bitmap.h) + +- **packet framework**: + * [port] (@ref rte_port.h): + [ethdev] (@ref rte_port_ethdev.h), + [ring] (@ref rte_port_ring.h), + [frag] (@ref rte_port_frag.h), + [reass] (@ref rte_port_ras.h), + [sched] (@ref rte_port_sched.h), + [src/sink] (@ref rte_port_source_sink.h) + * [table] (@ref rte_table.h): + [lpm IPv4] (@ref rte_table_lpm.h), + [lpm IPv6] (@ref rte_table_lpm_ipv6.h), + [ACL] (@ref rte_table_acl.h), + [hash] (@ref rte_table_hash.h), + [array] (@ref rte_table_array.h), + [stub] (@ref rte_table_stub.h) + * [pipeline] (@ref rte_pipeline.h) + +- **basic**: + [approx fraction] (@ref rte_approx.h), + [random] (@ref rte_random.h), + [key/value args] (@ref rte_kvargs.h), + [string] (@ref rte_string_fns.h) + +- **debug**: + [debug] (@ref rte_debug.h), + [log] (@ref rte_log.h), + [warnings] (@ref rte_warnings.h), + [errno] (@ref rte_errno.h) + +- **misc**: + [EAL config] (@ref rte_eal.h), + [common] (@ref rte_common.h), + [version] (@ref rte_version.h) diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf new file mode 100644 index 0000000000..fe3879fa0c --- /dev/null +++ b/doc/api/doxy-api.conf @@ -0,0 +1,77 @@ +# BSD LICENSE +# +# Copyright 2013 6WIND S.A. +# +# 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 +INPUT = doc/api/doxy-api-index.md \ + lib/librte_eal/common/include \ + lib/librte_acl \ + lib/librte_distributor \ + lib/librte_ether \ + lib/librte_hash \ + lib/librte_ip_frag \ + lib/librte_kni \ + lib/librte_kvargs \ + lib/librte_lpm \ + lib/librte_malloc \ + lib/librte_mbuf \ + lib/librte_mempool \ + lib/librte_meter \ + lib/librte_net \ + lib/librte_pipeline \ + lib/librte_port \ + lib/librte_power \ + lib/librte_pmd_bond \ + lib/librte_ring \ + lib/librte_sched \ + lib/librte_table \ + lib/librte_timer \ + lib/librte_vhost +FILE_PATTERNS = rte_*.h \ + cmdline.h +PREDEFINED = __DOXYGEN__ \ + __attribute__(x)= \ + RTE_MBUF_REFCNT + +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 +GENERATE_DEPRECATEDLIST = NO +VERBATIM_HEADERS = NO +ALPHABETICAL_INDEX = NO + +HTML_TIMESTAMP = NO +HTML_DYNAMIC_SECTIONS = YES +SEARCHENGINE = NO diff --git a/doc/api/doxy-html-custom.sh b/doc/api/doxy-html-custom.sh new file mode 100755 index 0000000000..e684a75a07 --- /dev/null +++ b/doc/api/doxy-html-custom.sh @@ -0,0 +1,36 @@ +#! /bin/sh -e + +# BSD LICENSE +# +# Copyright 2013 6WIND S.A. +# +# 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. + +CSS=$1 + +# space between item and its comment +echo 'dd td:first-child {padding-right: 2em;}' >> $CSS diff --git a/doc/doxy-api-index.md b/doc/doxy-api-index.md deleted file mode 100644 index 6958f8f9a3..0000000000 --- a/doc/doxy-api-index.md +++ /dev/null @@ -1,137 +0,0 @@ -API {#index} -=== - - - -There are many libraries, so their headers may be grouped by topics: - -- **device**: - [ethdev] (@ref rte_ethdev.h), - [devargs] (@ref rte_devargs.h), - [bond] (@ref rte_eth_bond.h), - [vhost] (@ref rte_virtio_net.h), - [KNI] (@ref rte_kni.h), - [PCI] (@ref rte_pci.h), - [PCI IDs] (@ref rte_pci_dev_ids.h) - -- **memory**: - [memseg] (@ref rte_memory.h), - [memzone] (@ref rte_memzone.h), - [mempool] (@ref rte_mempool.h), - [malloc] (@ref rte_malloc.h), - [memcpy] (@ref rte_memcpy.h) - -- **timers**: - [cycles] (@ref rte_cycles.h), - [timer] (@ref rte_timer.h), - [alarm] (@ref rte_alarm.h) - -- **locks**: - [atomic] (@ref rte_atomic.h), - [rwlock] (@ref rte_rwlock.h), - [spinlock] (@ref rte_spinlock.h) - -- **CPU arch**: - [branch prediction] (@ref rte_branch_prediction.h), - [cache prefetch] (@ref rte_prefetch.h), - [byte order] (@ref rte_byteorder.h), - [CPU flags] (@ref rte_cpuflags.h) - -- **CPU multicore**: - [interrupts] (@ref rte_interrupts.h), - [launch] (@ref rte_launch.h), - [lcore] (@ref rte_lcore.h), - [per-lcore] (@ref rte_per_lcore.h), - [power/freq] (@ref rte_power.h) - -- **layers**: - [ethernet] (@ref rte_ether.h), - [IP] (@ref rte_ip.h), - [SCTP] (@ref rte_sctp.h), - [TCP] (@ref rte_tcp.h), - [UDP] (@ref rte_udp.h), - [frag/reass] (@ref rte_ip_frag.h), - [LPM route] (@ref rte_lpm.h), - [ACL] (@ref rte_acl.h) - -- **QoS**: - [metering] (@ref rte_meter.h), - [scheduler] (@ref rte_sched.h), - [RED congestion] (@ref rte_red.h) - -- **hashes**: - [hash] (@ref rte_hash.h), - [jhash] (@ref rte_jhash.h), - [FBK hash] (@ref rte_fbk_hash.h), - [CRC hash] (@ref rte_hash_crc.h) - -- **containers**: - [mbuf] (@ref rte_mbuf.h), - [ring] (@ref rte_ring.h), - [distributor] (@ref rte_distributor.h), - [tailq] (@ref rte_tailq.h), - [bitmap] (@ref rte_bitmap.h) - -- **packet framework**: - * [port] (@ref rte_port.h): - [ethdev] (@ref rte_port_ethdev.h), - [ring] (@ref rte_port_ring.h), - [frag] (@ref rte_port_frag.h), - [reass] (@ref rte_port_ras.h), - [sched] (@ref rte_port_sched.h), - [src/sink] (@ref rte_port_source_sink.h) - * [table] (@ref rte_table.h): - [lpm IPv4] (@ref rte_table_lpm.h), - [lpm IPv6] (@ref rte_table_lpm_ipv6.h), - [ACL] (@ref rte_table_acl.h), - [hash] (@ref rte_table_hash.h), - [array] (@ref rte_table_array.h), - [stub] (@ref rte_table_stub.h) - * [pipeline] (@ref rte_pipeline.h) - -- **basic**: - [approx fraction] (@ref rte_approx.h), - [random] (@ref rte_random.h), - [key/value args] (@ref rte_kvargs.h), - [string] (@ref rte_string_fns.h) - -- **debug**: - [debug] (@ref rte_debug.h), - [log] (@ref rte_log.h), - [warnings] (@ref rte_warnings.h), - [errno] (@ref rte_errno.h) - -- **misc**: - [EAL config] (@ref rte_eal.h), - [common] (@ref rte_common.h), - [version] (@ref rte_version.h) diff --git a/doc/doxy-api.conf b/doc/doxy-api.conf deleted file mode 100644 index d3d2269496..0000000000 --- a/doc/doxy-api.conf +++ /dev/null @@ -1,77 +0,0 @@ -# BSD LICENSE -# -# Copyright 2013 6WIND S.A. -# -# 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 -INPUT = doc/doxy-api-index.md \ - lib/librte_eal/common/include \ - lib/librte_acl \ - lib/librte_distributor \ - lib/librte_ether \ - lib/librte_hash \ - lib/librte_ip_frag \ - lib/librte_kni \ - lib/librte_kvargs \ - lib/librte_lpm \ - lib/librte_malloc \ - lib/librte_mbuf \ - lib/librte_mempool \ - lib/librte_meter \ - lib/librte_net \ - lib/librte_pipeline \ - lib/librte_port \ - lib/librte_power \ - lib/librte_pmd_bond \ - lib/librte_ring \ - lib/librte_sched \ - lib/librte_table \ - lib/librte_timer \ - lib/librte_vhost -FILE_PATTERNS = rte_*.h \ - cmdline.h -PREDEFINED = __DOXYGEN__ \ - __attribute__(x)= \ - RTE_MBUF_REFCNT - -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 -GENERATE_DEPRECATEDLIST = NO -VERBATIM_HEADERS = NO -ALPHABETICAL_INDEX = NO - -HTML_TIMESTAMP = NO -HTML_DYNAMIC_SECTIONS = YES -SEARCHENGINE = NO diff --git a/doc/doxy-html-custom.sh b/doc/doxy-html-custom.sh deleted file mode 100755 index e684a75a07..0000000000 --- a/doc/doxy-html-custom.sh +++ /dev/null @@ -1,36 +0,0 @@ -#! /bin/sh -e - -# BSD LICENSE -# -# Copyright 2013 6WIND S.A. -# -# 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. - -CSS=$1 - -# space between item and its comment -echo 'dd td:first-child {padding-right: 2em;}' >> $CSS diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index c2deb10f40..f305bf98e8 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -51,7 +51,7 @@ clean: api-html-clean api-html: api-html-clean @echo 'doxygen for API...' $(Q)mkdir -p $(RTE_OUTPUT)/doc/html - $(Q)(cat $(RTE_SDK)/doc/doxy-api.conf && \ + $(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf && \ printf 'PROJECT_NUMBER = ' && \ $(MAKE) -rR showversion && \ echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \ @@ -60,7 +60,7 @@ api-html: api-html-clean echo GENERATE_LATEX = NO && \ echo GENERATE_MAN = NO )| \ doxygen - - $(Q)$(RTE_SDK)/doc/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css + $(Q)$(RTE_SDK)/doc/api/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css .PHONY: api-html-clean api-html-clean: