diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/doxy-api-index.md | 26 | ||||
| -rw-r--r-- | doc/api/doxy-api.conf | 12 | ||||
| -rw-r--r-- | doc/api/examples.dox | 111 |
3 files changed, 30 insertions, 119 deletions
diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md index 6675f965..f5f1f199 100644 --- a/doc/api/doxy-api-index.md +++ b/doc/api/doxy-api-index.md @@ -4,7 +4,7 @@ API {#index} <!-- BSD LICENSE - Copyright 2013 6WIND S.A. + Copyright 2013-2017 6WIND S.A. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions @@ -39,12 +39,20 @@ There are many libraries, so their headers may be grouped by topics: [dev] (@ref rte_dev.h), [ethdev] (@ref rte_ethdev.h), [ethctrl] (@ref rte_eth_ctrl.h), + [rte_flow] (@ref rte_flow.h), + [rte_flow_driver] (@ref rte_flow_driver.h), [cryptodev] (@ref rte_cryptodev.h), + [eventdev] (@ref rte_eventdev.h), [devargs] (@ref rte_devargs.h), + [PCI] (@ref rte_pci.h) + +- **device specific**: [bond] (@ref rte_eth_bond.h), - [vhost] (@ref rte_virtio_net.h), + [vhost] (@ref rte_vhost.h), [KNI] (@ref rte_kni.h), - [PCI] (@ref rte_pci.h), + [ixgbe] (@ref rte_pmd_ixgbe.h), + [i40e] (@ref rte_pmd_i40e.h), + [crypto_scheduler] (@ref rte_cryptodev_scheduler.h) - **memory**: [memseg] (@ref rte_memory.h), @@ -66,8 +74,10 @@ There are many libraries, so their headers may be grouped by topics: - **CPU arch**: [branch prediction] (@ref rte_branch_prediction.h), [cache prefetch] (@ref rte_prefetch.h), + [SIMD] (@ref rte_vect.h), [byte order] (@ref rte_byteorder.h), - [CPU flags] (@ref rte_cpuflags.h) + [CPU flags] (@ref rte_cpuflags.h), + [I/O access] (@ref rte_io.h) - **CPU multicore**: [interrupts] (@ref rte_interrupts.h), @@ -87,7 +97,8 @@ There are many libraries, so their headers may be grouped by topics: [frag/reass] (@ref rte_ip_frag.h), [LPM IPv4 route] (@ref rte_lpm.h), [LPM IPv6 route] (@ref rte_lpm6.h), - [ACL] (@ref rte_acl.h) + [ACL] (@ref rte_acl.h), + [EFD] (@ref rte_efd.h) - **QoS**: [metering] (@ref rte_meter.h), @@ -136,10 +147,10 @@ There are many libraries, so their headers may be grouped by topics: - **debug**: [jobstats] (@ref rte_jobstats.h), + [pdump] (@ref rte_pdump.h), [hexdump] (@ref rte_hexdump.h), [debug] (@ref rte_debug.h), [log] (@ref rte_log.h), - [warnings] (@ref rte_warnings.h), [errno] (@ref rte_errno.h) - **misc**: @@ -147,4 +158,7 @@ There are many libraries, so their headers may be grouped by topics: [common] (@ref rte_common.h), [ABI compat] (@ref rte_compat.h), [keepalive] (@ref rte_keepalive.h), + [device metrics] (@ref rte_metrics.h), + [bitrate statistics] (@ref rte_bitrate.h), + [latency statistics] (@ref rte_latencystats.h), [version] (@ref rte_version.h) diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf index 9dc7ae5c..ca9194fe 100644 --- a/doc/api/doxy-api.conf +++ b/doc/api/doxy-api.conf @@ -1,6 +1,6 @@ # BSD LICENSE # -# Copyright 2013 6WIND S.A. +# Copyright 2013-2017 6WIND S.A. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions @@ -30,27 +30,35 @@ PROJECT_NAME = DPDK INPUT = doc/api/doxy-api-index.md \ - doc/api/examples.dox \ + drivers/crypto/scheduler \ drivers/net/bonding \ + drivers/net/i40e \ + drivers/net/ixgbe \ lib/librte_eal/common/include \ lib/librte_eal/common/include/generic \ lib/librte_acl \ + lib/librte_bitratestats \ lib/librte_cfgfile \ lib/librte_cmdline \ lib/librte_compat \ lib/librte_cryptodev \ lib/librte_distributor \ + lib/librte_efd \ lib/librte_ether \ + lib/librte_eventdev \ lib/librte_hash \ lib/librte_ip_frag \ lib/librte_jobstats \ lib/librte_kni \ lib/librte_kvargs \ + lib/librte_latencystats \ lib/librte_lpm \ lib/librte_mbuf \ lib/librte_mempool \ lib/librte_meter \ + lib/librte_metrics \ lib/librte_net \ + lib/librte_pdump \ lib/librte_pipeline \ lib/librte_port \ lib/librte_power \ diff --git a/doc/api/examples.dox b/doc/api/examples.dox deleted file mode 100644 index 1626852c..00000000 --- a/doc/api/examples.dox +++ /dev/null @@ -1,111 +0,0 @@ -/** -@page examples DPDK Example Programs - -@example bond/main.c -@example cmdline/commands.c -@example cmdline/main.c -@example cmdline/parse_obj_list.c -@example distributor/main.c -@example dpdk_qat/crypto.c -@example dpdk_qat/main.c -@example ethtool/ethtool-app/ethapp.c -@example ethtool/ethtool-app/main.c -@example ethtool/lib/rte_ethtool.c -@example exception_path/main.c -@example helloworld/main.c -@example ip_fragmentation/main.c -@example ip_pipeline/config_check.c -@example ip_pipeline/config_parse.c -@example ip_pipeline/config_parse_tm.c -@example ip_pipeline/cpu_core_map.c -@example ip_pipeline/init.c -@example ip_pipeline/main.c -@example ip_pipeline/pipeline/pipeline_common_be.c -@example ip_pipeline/pipeline/pipeline_common_fe.c -@example ip_pipeline/pipeline/pipeline_firewall_be.c -@example ip_pipeline/pipeline/pipeline_firewall.c -@example ip_pipeline/pipeline/pipeline_flow_actions_be.c -@example ip_pipeline/pipeline/pipeline_flow_actions.c -@example ip_pipeline/pipeline/pipeline_flow_classification_be.c -@example ip_pipeline/pipeline/pipeline_flow_classification.c -@example ip_pipeline/pipeline/pipeline_master_be.c -@example ip_pipeline/pipeline/pipeline_master.c -@example ip_pipeline/pipeline/pipeline_passthrough_be.c -@example ip_pipeline/pipeline/pipeline_passthrough.c -@example ip_pipeline/pipeline/pipeline_routing_be.c -@example ip_pipeline/pipeline/pipeline_routing.c -@example ip_pipeline/thread.c -@example ip_pipeline/thread_fe.c -@example ip_reassembly/main.c -@example ipv4_multicast/main.c -@example kni/main.c -@example l2fwd-crypto/main.c -@example l2fwd-jobstats/main.c -@example l2fwd-keepalive/main.c -@example l2fwd/main.c -@example l3fwd-acl/main.c -@example l3fwd/main.c -@example l3fwd-power/main.c -@example l3fwd-vf/main.c -@example link_status_interrupt/main.c -@example load_balancer/config.c -@example load_balancer/init.c -@example load_balancer/main.c -@example load_balancer/runtime.c -@example multi_process/client_server_mp/mp_client/client.c -@example multi_process/client_server_mp/mp_server/args.c -@example multi_process/client_server_mp/mp_server/init.c -@example multi_process/client_server_mp/mp_server/main.c -@example multi_process/l2fwd_fork/flib.c -@example multi_process/l2fwd_fork/main.c -@example multi_process/simple_mp/main.c -@example multi_process/simple_mp/mp_commands.c -@example multi_process/symmetric_mp/main.c -@example netmap_compat/bridge/bridge.c -@example netmap_compat/lib/compat_netmap.c -@example packet_ordering/main.c -@example performance-thread/common/arch/x86/ctx.c -@example performance-thread/common/lthread.c -@example performance-thread/common/lthread_cond.c -@example performance-thread/common/lthread_diag.c -@example performance-thread/common/lthread_mutex.c -@example performance-thread/common/lthread_sched.c -@example performance-thread/common/lthread_tls.c -@example performance-thread/l3fwd-thread/main.c -@example performance-thread/pthread_shim/main.c -@example performance-thread/pthread_shim/pthread_shim.c -@example ptpclient/ptpclient.c -@example qos_meter/main.c -@example qos_meter/rte_policer.c -@example qos_sched/app_thread.c -@example qos_sched/args.c -@example qos_sched/cfg_file.c -@example qos_sched/cmdline.c -@example qos_sched/init.c -@example qos_sched/main.c -@example qos_sched/stats.c -@example quota_watermark/qw/args.c -@example quota_watermark/qwctl/commands.c -@example quota_watermark/qwctl/qwctl.c -@example quota_watermark/qw/init.c -@example quota_watermark/qw/main.c -@example rxtx_callbacks/main.c -@example skeleton/basicfwd.c -@example tep_termination/main.c -@example tep_termination/vxlan.c -@example tep_termination/vxlan_setup.c -@example timer/main.c -@example vhost/main.c -@example vhost_xen/main.c -@example vhost_xen/vhost_monitor.c -@example vhost_xen/xenstore_parse.c -@example vmdq_dcb/main.c -@example vmdq/main.c -@example vm_power_manager/channel_manager.c -@example vm_power_manager/channel_monitor.c -@example vm_power_manager/guest_cli/main.c -@example vm_power_manager/guest_cli/vm_power_cli_guest.c -@example vm_power_manager/main.c -@example vm_power_manager/power_manager.c -@example vm_power_manager/vm_power_cli.c -*/ |