[dpdk-dev] [PATCH 1/2] doc: remove lists of figure and table references

[dpdk-dev] [PATCH 1/2] doc: remove lists of figure and table references

[Thomas Monjalon]

The references to the figures and tables in the index
are not maintained.

It is probably better to have no list than an incomplete list.
Anyway the usage of such figures list is not obvious.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/nics/index.rst          |  20 ---
 doc/guides/prog_guide/index.rst    | 200 -----------------------------
 doc/guides/sample_app_ug/index.rst |  60 ---------
 3 files changed, 280 deletions(-)

diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index bb107ae5c..1e4670501 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -51,23 +51,3 @@ Network Interface Controller Drivers
     vmxnet3
     pcap_ring
     fail_safe
-
-**Figures**
-
-:numref:`figure_single_port_nic` :ref:`figure_single_port_nic`
-
-:numref:`figure_perf_benchmark` :ref:`figure_perf_benchmark`
-
-:numref:`figure_fast_pkt_proc` :ref:`figure_fast_pkt_proc`
-
-:numref:`figure_inter_vm_comms` :ref:`figure_inter_vm_comms`
-
-:numref:`figure_host_vm_comms` :ref:`figure_host_vm_comms`
-
-:numref:`figure_host_vm_comms_qemu` :ref:`figure_host_vm_comms_qemu`
-
-:numref:`figure_vmxnet3_int` :ref:`figure_vmxnet3_int`
-
-:numref:`figure_vswitch_vm` :ref:`figure_vswitch_vm`
-
-:numref:`figure_vm_vm_comms` :ref:`figure_vm_vm_comms`
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index 2086e2442..ba8c1f6ad 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -64,203 +64,3 @@ Programmer's Guide
     writing_efficient_code
     profile_app
     glossary
-
-
-**Figures**
-
-:numref:`figure_architecture-overview` :ref:`figure_architecture-overview`
-
-:numref:`figure_linuxapp_launch` :ref:`figure_linuxapp_launch`
-
-:numref:`figure_malloc_heap` :ref:`figure_malloc_heap`
-
-:numref:`figure_ring1` :ref:`figure_ring1`
-
-:numref:`figure_ring-enqueue1` :ref:`figure_ring-enqueue1`
-
-:numref:`figure_ring-enqueue2` :ref:`figure_ring-enqueue2`
-
-:numref:`figure_ring-enqueue3` :ref:`figure_ring-enqueue3`
-
-:numref:`figure_ring-dequeue1` :ref:`figure_ring-dequeue1`
-
-:numref:`figure_ring-dequeue2` :ref:`figure_ring-dequeue2`
-
-:numref:`figure_ring-dequeue3` :ref:`figure_ring-dequeue3`
-
-:numref:`figure_ring-mp-enqueue1` :ref:`figure_ring-mp-enqueue1`
-
-:numref:`figure_ring-mp-enqueue2` :ref:`figure_ring-mp-enqueue2`
-
-:numref:`figure_ring-mp-enqueue3` :ref:`figure_ring-mp-enqueue3`
-
-:numref:`figure_ring-mp-enqueue4` :ref:`figure_ring-mp-enqueue4`
-
-:numref:`figure_ring-mp-enqueue5` :ref:`figure_ring-mp-enqueue5`
-
-:numref:`figure_ring-modulo1` :ref:`figure_ring-modulo1`
-
-:numref:`figure_ring-modulo2` :ref:`figure_ring-modulo2`
-
-:numref:`figure_memory-management` :ref:`figure_memory-management`
-
-:numref:`figure_memory-management2` :ref:`figure_memory-management2`
-
-:numref:`figure_mempool` :ref:`figure_mempool`
-
-:numref:`figure_mbuf1` :ref:`figure_mbuf1`
-
-:numref:`figure_mbuf2` :ref:`figure_mbuf2`
-
-:numref:`figure_multi_process_memory` :ref:`figure_multi_process_memory`
-
-:numref:`figure_kernel_nic_intf` :ref:`figure_kernel_nic_intf`
-
-:numref:`figure_pkt_flow_kni` :ref:`figure_pkt_flow_kni`
-
-
-:numref:`figure_pkt_proc_pipeline_qos` :ref:`figure_pkt_proc_pipeline_qos`
-
-:numref:`figure_hier_sched_blk` :ref:`figure_hier_sched_blk`
-
-:numref:`figure_sched_hier_per_port` :ref:`figure_sched_hier_per_port`
-
-:numref:`figure_data_struct_per_port` :ref:`figure_data_struct_per_port`
-
-:numref:`figure_prefetch_pipeline` :ref:`figure_prefetch_pipeline`
-
-:numref:`figure_pipe_prefetch_sm` :ref:`figure_pipe_prefetch_sm`
-
-:numref:`figure_blk_diag_dropper` :ref:`figure_blk_diag_dropper`
-
-:numref:`figure_flow_tru_droppper` :ref:`figure_flow_tru_droppper`
-
-:numref:`figure_ex_data_flow_tru_dropper` :ref:`figure_ex_data_flow_tru_dropper`
-
-:numref:`figure_pkt_drop_probability` :ref:`figure_pkt_drop_probability`
-
-:numref:`figure_drop_probability_graph` :ref:`figure_drop_probability_graph`
-
-:numref:`figure_figure32` :ref:`figure_figure32`
-
-:numref:`figure_figure33` :ref:`figure_figure33`
-
-:numref:`figure_figure34` :ref:`figure_figure34`
-
-:numref:`figure_figure35` :ref:`figure_figure35`
-
-:numref:`figure_figure37` :ref:`figure_figure37`
-
-:numref:`figure_figure38` :ref:`figure_figure38`
-
-:numref:`figure_figure39` :ref:`figure_figure39`
-
-:numref:`figure_efd1` :ref:`figure_efd1`
-
-:numref:`figure_efd2` :ref:`figure_efd2`
-
-:numref:`figure_efd3` :ref:`figure_efd3`
-
-:numref:`figure_efd4` :ref:`figure_efd4`
-
-:numref:`figure_efd5` :ref:`figure_efd5`
-
-:numref:`figure_efd6` :ref:`figure_efd6`
-
-:numref:`figure_efd7` :ref:`figure_efd7`
-
-:numref:`figure_efd8` :ref:`figure_efd8`
-
-:numref:`figure_efd9` :ref:`figure_efd9`
-
-:numref:`figure_efd10` :ref:`figure_efd10`
-
-:numref:`figure_efd11` :ref:`figure_efd11`
-
-:numref:`figure_membership1` :ref:`figure_membership1`
-
-:numref:`figure_membership2` :ref:`figure_membership2`
-
-:numref:`figure_membership3` :ref:`figure_membership3`
-
-:numref:`figure_membership4` :ref:`figure_membership4`
-
-:numref:`figure_membership5` :ref:`figure_membership5`
-
-:numref:`figure_membership6` :ref:`figure_membership6`
-
-:numref:`figure_membership7` :ref:`figure_membership7`
-
-**Tables**
-
-:numref:`table_qos_1` :ref:`table_qos_1`
-
-:numref:`table_qos_2` :ref:`table_qos_2`
-
-:numref:`table_qos_3` :ref:`table_qos_3`
-
-:numref:`table_qos_4` :ref:`table_qos_4`
-
-:numref:`table_qos_5` :ref:`table_qos_5`
-
-:numref:`table_qos_6` :ref:`table_qos_6`
-
-:numref:`table_qos_7` :ref:`table_qos_7`
-
-:numref:`table_qos_8` :ref:`table_qos_8`
-
-:numref:`table_qos_9` :ref:`table_qos_9`
-
-:numref:`table_qos_10` :ref:`table_qos_10`
-
-:numref:`table_qos_11` :ref:`table_qos_11`
-
-:numref:`table_qos_12` :ref:`table_qos_12`
-
-:numref:`table_qos_13` :ref:`table_qos_13`
-
-:numref:`table_qos_14` :ref:`table_qos_14`
-
-:numref:`table_qos_15` :ref:`table_qos_15`
-
-:numref:`table_qos_16` :ref:`table_qos_16`
-
-:numref:`table_qos_17` :ref:`table_qos_17`
-
-:numref:`table_qos_18` :ref:`table_qos_18`
-
-:numref:`table_qos_19` :ref:`table_qos_19`
-
-:numref:`table_qos_20` :ref:`table_qos_20`
-
-:numref:`table_qos_21` :ref:`table_qos_21`
-
-:numref:`table_qos_22` :ref:`table_qos_22`
-
-:numref:`table_qos_23` :ref:`table_qos_23`
-
-:numref:`table_qos_24` :ref:`table_qos_24`
-
-:numref:`table_qos_25` :ref:`table_qos_25`
-
-:numref:`table_qos_26` :ref:`table_qos_26`
-
-:numref:`table_qos_27` :ref:`table_qos_27`
-
-:numref:`table_qos_28` :ref:`table_qos_28`
-
-:numref:`table_qos_29` :ref:`table_qos_29`
-
-:numref:`table_qos_30` :ref:`table_qos_30`
-
-:numref:`table_qos_31` :ref:`table_qos_31`
-
-:numref:`table_qos_32` :ref:`table_qos_32`
-
-:numref:`table_qos_33` :ref:`table_qos_33`
-
-:numref:`table_qos_34` :ref:`table_qos_34`
-
-:numref:`table_hash_lib_1` :ref:`table_hash_lib_1`
-
-:numref:`table_hash_lib_2` :ref:`table_hash_lib_2`
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index b2455e093..2945be08f 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -58,63 +58,3 @@ Sample Applications User Guides
     fips_validation
     ipsec_secgw
     bbdev_app
-
-**Figures**
-
-:numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
-
-:numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
-
-:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
-
-:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
-
-:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
-
-:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
-
-:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
-
-:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
-
-:numref:`figure_example_rules` :ref:`figure_example_rules`
-
-:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
-
-:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
-
-:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
-
-:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
-
-:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
-
-:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
-
-:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
-
-:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
-
-:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
-
-:numref:`figure_dist_perf` :ref:`figure_dist_perf`
-
-:numref:`figure_dist_app` :ref:`figure_dist_app`
-
-:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
-
-:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
-:numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
-:numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
-
-:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
-
-:numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview`
-
-**Tables**
-
-:numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
-
-:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1`
-
-:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1`
-- 
2.19.0

[dpdk-dev] [PATCH 2/2] doc: remove PCI-specific details from EAL guide

[Thomas Monjalon]

The PCI bus is an independent driver and not part of EAL
as it was in the early days.
EAL must be understood as a generic layer.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/prog_guide/env_abstraction_layer.rst | 15 +--------------
 1 file changed, 1 insertion(+), 14 deletions(-)

diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index 4f8612a24..8b5d050c7 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -9,7 +9,7 @@ Environment Abstraction Layer
 The Environment Abstraction Layer (EAL) is responsible for gaining access to low-level resources such as hardware and memory space.
 It provides a generic interface that hides the environment specifics from the applications and libraries.
 It is the responsibility of the initialization routine to decide how to allocate these resources
-(that is, memory space, PCI devices, timers, consoles, and so on).
+(that is, memory space, devices, timers, consoles, and so on).
 
 Typical services expected from the EAL are:
 
@@ -22,8 +22,6 @@ Typical services expected from the EAL are:
 *   System Memory Reservation:
     The EAL facilitates the reservation of different memory zones, for example, physical memory areas for device interactions.
 
-*   PCI Address Abstraction: The EAL provides an interface to access PCI address space.
-
 *   Trace and Debug Functions: Logs, dump_stack, panic and so on.
 
 *   Utility Functions: Spinlocks and atomic counters that are not provided in libc.
@@ -39,8 +37,6 @@ EAL in a Linux-userland Execution Environment
 ---------------------------------------------
 
 In a Linux user space environment, the DPDK application runs as a user-space application using the pthread library.
-PCI information about devices and address space is discovered through the /sys kernel interface and through kernel modules such as uio_pci_generic, or igb_uio.
-Refer to the UIO: User-space drivers documentation in the Linux kernel. This memory is mmap'd in the application.
 
 The EAL performs physical memory allocation using mmap() in hugetlbfs (using huge page sizes to increase performance).
 This memory is exposed to DPDK service layers such as the :ref:`Mempool Library <Mempool_Library>`.
@@ -250,15 +246,6 @@ The expected workflow is as follows:
 For more information, please refer to ``rte_malloc`` API documentation,
 specifically the ``rte_malloc_heap_*`` family of function calls.
 
-PCI Access
-~~~~~~~~~~
-
-The EAL uses the /sys/bus/pci utilities provided by the kernel to scan the content on the PCI bus.
-To access PCI memory, a kernel module called uio_pci_generic provides a /dev/uioX device file
-and resource files in /sys
-that can be mmap'd to obtain access to PCI address space from the application.
-The DPDK-specific igb_uio module can also be used for this. Both drivers use the uio kernel feature (userland driver).
-
 Per-lcore and Shared Variables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.19.0

Re: [dpdk-dev] [PATCH 1/2] doc: remove lists of figure and table references

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, November 22, 2018 2:19 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Subject: [PATCH 1/2] doc: remove lists of figure and table references
> 
> The references to the figures and tables in the index are not maintained.
> 
> It is probably better to have no list than an incomplete list.

+100

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH 2/2] doc: remove PCI-specific details from EAL guide

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, November 22, 2018 2:19 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Subject: [PATCH 2/2] doc: remove PCI-specific details from EAL guide
> 
> The PCI bus is an independent driver and not part of EAL as it was in the
> early days.
> EAL must be understood as a generic layer.


Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH 1/2] doc: remove lists of figure and table references

[Thomas Monjalon]

22/11/2018 19:04, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> > 
> > The references to the figures and tables in the index are not maintained.
> > 
> > It is probably better to have no list than an incomplete list.
> 
> +100
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks for the support