|WARNING| pw134943 [PATCH] [1/1] Modified Programmer's Guide index for better organization and readability

[dpdklab at iol.unh.edu]

Test-Label: iol-testing
Test-Status: WARNING
http://dpdk.org/patch/134943

_apply patch failure_

Submitter: David Young <dave at youngcopy.com>
Date: Friday, December 08 2023 02:11:08 
Applied on: CommitID:f2d5afbb2c05d7647da7ea914887c52115652651
Apply patch set 134943 failed:

.git/rebase-apply/patch:290: trailing whitespace.
    glossary    
Checking patch doc/guides/prog_guide/bpf_lib.rst...
Checking patch doc/guides/prog_guide/dmadev.rst...
Checking patch doc/guides/prog_guide/efd_lib.rst...
Checking patch doc/guides/prog_guide/env_abstraction_layer.rst...
Checking patch doc/guides/prog_guide/ethdev/index.rst...
Checking patch doc/guides/prog_guide/poll_mode_drv.rst => doc/guides/prog_guide/ethdev/poll_mode_drv.rst...
Checking patch doc/guides/prog_guide/qos_framework.rst => doc/guides/prog_guide/ethdev/qos_framework.rst...
Checking patch doc/guides/prog_guide/rte_flow.rst => doc/guides/prog_guide/ethdev/rte_flow.rst...
Checking patch doc/guides/prog_guide/switch_representation.rst => doc/guides/prog_guide/ethdev/switch_representation.rst...
Checking patch doc/guides/prog_guide/traffic_management.rst => doc/guides/prog_guide/ethdev/traffic_management.rst...
Checking patch doc/guides/prog_guide/traffic_metering_and_policing.rst => doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst...
Checking patch doc/guides/prog_guide/event_crypto_adapter.rst => doc/guides/prog_guide/eventdev/event_crypto_adapter.rst...
Checking patch doc/guides/prog_guide/event_ethernet_rx_adapter.rst => doc/guides/prog_guide/eventdev/event_ethernet_rx_adapter.rst...
Checking patch doc/guides/prog_guide/event_ethernet_tx_adapter.rst => doc/guides/prog_guide/eventdev/event_ethernet_tx_adapter.rst...
Checking patch doc/guides/prog_guide/event_timer_adapter.rst => doc/guides/prog_guide/eventdev/event_timer_adapter.rst...
Checking patch doc/guides/prog_guide/eventdev.rst => doc/guides/prog_guide/eventdev/eventdev.rst...
Checking patch doc/guides/prog_guide/eventdev/index.rst...
Checking patch doc/guides/prog_guide/fib_lib.rst...
Checking patch doc/guides/prog_guide/generic_receive_offload_lib.rst...
Checking patch doc/guides/prog_guide/generic_segmentation_offload_lib.rst...
Checking patch doc/guides/prog_guide/gpudev.rst...
Checking patch doc/guides/prog_guide/index.rst...
error: while searching for:
Programmer's Guide
==================

.. toctree::
    :maxdepth: 3
    :numbered:

    intro
    overview
    source_org
    env_abstraction_layer
    log_lib
    service_cores
    trace_lib
    rcu_lib
    ring_lib
    stack_lib
    mempool_lib
    mbuf_lib
    poll_mode_drv
    rte_flow
    switch_representation
    traffic_metering_and_policing
    traffic_management
    bbdev
    cryptodev_lib
    compressdev
    regexdev

error: patch failed: doc/guides/prog_guide/index.rst:4
error: while searching for:
    rte_security
    rawdev
    link_bonding_poll_mode_drv_lib
    timer_lib
    hash_lib
    toeplitz_hash_lib
    efd_lib
    member_lib
    lpm_lib
    lpm6_lib
    fib_lib
    rib_lib
    packet_distrib_lib
    reorder_lib
    ip_fragment_reassembly_lib
    generic_receive_offload_lib
    generic_segmentation_offload_lib
    ipsec_lib
    pdcp_lib
    pcapng_lib
    pdump_lib
    multi_proc_support
    thread_safety_dpdk_functions
    eventdev
    event_ethernet_rx_adapter
    event_ethernet_tx_adapter
    event_timer_adapter
    event_crypto_adapter
    qos_framework
    power_man
    packet_classif_access_ctrl
    packet_framework
    vhost_lib
    metrics_lib
    telemetry_lib
    bpf_lib
    graph_lib
    build-sdk-meson
    meson_ut
    build_app
    perf_opt_guidelines
    writing_efficient_code
    lto
    profile_app
    asan
    glossary

error: patch failed: doc/guides/prog_guide/index.rst:35
Checking patch doc/guides/prog_guide/lpm6_lib.rst...
Checking patch doc/guides/prog_guide/lpm_lib.rst...
Checking patch doc/guides/prog_guide/mbuf_lib.rst...
Checking patch doc/guides/prog_guide/mempool_lib.rst...
Checking patch doc/guides/prog_guide/mldev.rst...
Checking patch doc/guides/prog_guide/packet_classif_access_ctrl.rst...
Checking patch doc/guides/prog_guide/packet_framework.rst...
Checking patch doc/guides/prog_guide/rawdev.rst...
Checking patch doc/guides/prog_guide/regexdev.rst...
Checking patch doc/guides/prog_guide/rib_lib.rst...
Checking patch doc/guides/prog_guide/thread_safety_dpdk_functions.rst => doc/guides/prog_guide/thread_safety.rst...
Applied patch doc/guides/prog_guide/bpf_lib.rst cleanly.
Applied patch doc/guides/prog_guide/dmadev.rst cleanly.
Applied patch doc/guides/prog_guide/efd_lib.rst cleanly.
Applied patch doc/guides/prog_guide/env_abstraction_layer.rst cleanly.
Applied patch doc/guides/prog_guide/ethdev/index.rst cleanly.
Applied patch doc/guides/prog_guide/poll_mode_drv.rst => doc/guides/prog_guide/ethdev/poll_mode_drv.rst cleanly.
Applied patch doc/guides/prog_guide/qos_framework.rst => doc/guides/prog_guide/ethdev/qos_framework.rst cleanly.
Applied patch doc/guides/prog_guide/rte_flow.rst => doc/guides/prog_guide/ethdev/rte_flow.rst cleanly.
Applied patch doc/guides/prog_guide/switch_representation.rst => doc/guides/prog_guide/ethdev/switch_representation.rst cleanly.
Applied patch doc/guides/prog_guide/traffic_management.rst => doc/guides/prog_guide/ethdev/traffic_management.rst cleanly.
Applied patch doc/guides/prog_guide/traffic_metering_and_policing.rst => doc/guides/prog_guide/ethdev/traffic_metering_and_policing.rst cleanly.
Applied patch doc/guides/prog_guide/event_crypto_adapter.rst => doc/guides/prog_guide/eventdev/event_crypto_adapter.rst cleanly.
Applied patch doc/guides/prog_guide/event_ethernet_rx_adapter.rst => doc/guides/prog_guide/eventdev/event_ethernet_rx_adapter.rst cleanly.
Applied patch doc/guides/prog_guide/event_ethernet_tx_adapter.rst => doc/guides/prog_guide/eventdev/event_ethernet_tx_adapter.rst cleanly.
Applied patch doc/guides/prog_guide/event_timer_adapter.rst => doc/guides/prog_guide/eventdev/event_timer_adapter.rst cleanly.
Applied patch doc/guides/prog_guide/eventdev.rst => doc/guides/prog_guide/eventdev/eventdev.rst cleanly.
Applied patch doc/guides/prog_guide/eventdev/index.rst cleanly.
Applied patch doc/guides/prog_guide/fib_lib.rst cleanly.
Applied patch doc/guides/prog_guide/generic_receive_offload_lib.rst cleanly.
Applied patch doc/guides/prog_guide/generic_segmentation_offload_lib.rst cleanly.
Applied patch doc/guides/prog_guide/gpudev.rst cleanly.
Applying patch doc/guides/prog_guide/index.rst with 2 rejects...
Rejected hunk #1.
Rejected hunk #2.
Applied patch doc/guides/prog_guide/lpm6_lib.rst cleanly.
Applied patch doc/guides/prog_guide/lpm_lib.rst cleanly.
Applied patch doc/guides/prog_guide/mbuf_lib.rst cleanly.
Applied patch doc/guides/prog_guide/mempool_lib.rst cleanly.
Applied patch doc/guides/prog_guide/mldev.rst cleanly.
Applied patch doc/guides/prog_guide/packet_classif_access_ctrl.rst cleanly.
Applied patch doc/guides/prog_guide/packet_framework.rst cleanly.
Applied patch doc/guides/prog_guide/rawdev.rst cleanly.
Applied patch doc/guides/prog_guide/regexdev.rst cleanly.
Applied patch doc/guides/prog_guide/rib_lib.rst cleanly.
Applied patch doc/guides/prog_guide/thread_safety_dpdk_functions.rst => doc/guides/prog_guide/thread_safety.rst cleanly.
hint: Use 'git am --show-current-patch' to see the failed patch
diff a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst	(rejected hunks)
@@ -4,28 +4,67 @@
 Programmer's Guide
 ==================
 
+Foundation Principles
+---------------------
+
 .. toctree::
-    :maxdepth: 3
-    :numbered:
+    :maxdepth: 1
 
     intro
     overview
     source_org
-    env_abstraction_layer
-    log_lib
-    service_cores
-    trace_lib
-    rcu_lib
-    ring_lib
-    stack_lib
+    glossary    
+
+Memory Management
+-----------------
+
+.. toctree::
+    :maxdepth: 1
+
     mempool_lib
     mbuf_lib
-    poll_mode_drv
-    rte_flow
-    switch_representation
-    traffic_metering_and_policing
-    traffic_management
-    bbdev
+    multi_proc_support
+
+CPU Management
+--------------
+
+.. toctree::
+    :maxdepth: 1
+
+    env_abstraction_layer
+    power_man
+    thread_safety
+    service_cores
+
+CPU Packet Processing
+---------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    lpm_lib
+    lpm6_lib
+    rib_lib
+    fib_lib
+    packet_classif_access_ctrl
+    packet_distrib_lib
+    efd_lib
+    reorder_lib
+    ip_fragment_reassembly_lib
+    generic_receive_offload_lib
+    generic_segmentation_offload_lib
+    toeplitz_hash_lib
+    hash_lib
+    member_lib
+
+Device Libraries
+----------------
+
+.. toctree::
+    :maxdepth: 1
+
+    ethdev/index
+    vhost_lib
     cryptodev_lib
     compressdev
     regexdev
@@ -35,46 +74,62 @@ Programmer's Guide
     rte_security
     rawdev
     link_bonding_poll_mode_drv_lib
+    bbdev
+    eventdev/index
+
+Utility Libraries
+-----------------
+
+.. toctree::
+    :maxdepth: 1
+
     timer_lib
-    hash_lib
-    toeplitz_hash_lib
-    efd_lib
-    member_lib
-    lpm_lib
-    lpm6_lib
-    fib_lib
-    rib_lib
-    packet_distrib_lib
-    reorder_lib
-    ip_fragment_reassembly_lib
-    generic_receive_offload_lib
-    generic_segmentation_offload_lib
-    ipsec_lib
-    pdcp_lib
-    pcapng_lib
-    pdump_lib
-    multi_proc_support
-    thread_safety_dpdk_functions
-    eventdev
-    event_ethernet_rx_adapter
-    event_ethernet_tx_adapter
-    event_timer_adapter
-    event_crypto_adapter
-    qos_framework
-    power_man
-    packet_classif_access_ctrl
-    packet_framework
-    vhost_lib
+    rcu_lib
+    ring_lib
+    stack_lib
     metrics_lib
     telemetry_lib
+    pdump_lib
+    pcapng_lib
     bpf_lib
+    trace_lib
+
+Protocol Processing Libraries
+-----------------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    pdcp_lib
+    ipsec_lib
+
+High-Level Libraries
+--------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    packet_framework
     graph_lib
+
+Howto Guides
+-------------
+
+.. toctree::
+    :maxdepth: 1
+
     build-sdk-meson
     meson_ut
     build_app
+
+Tips & Tricks
+-------------
+
+.. toctree::
+    :maxdepth: 1
+
     perf_opt_guidelines
     writing_efficient_code
     lto
     profile_app
     asan
-    glossary

https://lab.dpdk.org/results/dashboard/patchsets/28559/

UNH-IOL DPDK Community Lab