diff mbox series

[1/2] doc: remove lists of figure and table references

Message ID 20181122141835.26151-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series [1/2] doc: remove lists of figure and table references | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS

Commit Message

Thomas Monjalon Nov. 22, 2018, 2:18 p.m. UTC
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(-)

Comments

Mcnamara, John Nov. 22, 2018, 6:04 p.m. UTC | #1
> -----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>
Thomas Monjalon Nov. 23, 2018, 1:58 a.m. UTC | #2
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
diff mbox series

Patch

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`