|WARNING| pw108747 [PATCH] [22.07] doc: make doc roadmap common for Linux/BSD GSGs

[dpdklab at iol.unh.edu]

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

_apply patch failure_

Submitter: Bruce Richardson <bruce.richardson at intel.com>
Date: Wednesday, March 16 2022 16:05:46 
Applied on: CommitID:0e45ace534e0582fedc052759585e8a1d5767531
Apply patch set 108747 failed:

Checking patch doc/guides/freebsd_gsg/intro.rst...
error: while searching for:
Documentation Roadmap
---------------------

The following is a list of DPDK documents in the suggested reading order:

*   :doc:`../rel_notes/index`: Provides release-specific information, including supported
    features, limitations, fixed issues, known issues and so on.  Also, provides the
    answers to frequently asked questions in FAQ format.

*   :doc:`../freebsd_gsg/index` (this document): Describes how to install and
    configure the DPDK; designed to get users up and running quickly with the
    software.

*   :doc:`../prog_guide/index`: Describes:

    *   The software architecture and how to use it (through examples),
        specifically in a Linux* application (linux) environment

    *   The content of the DPDK, the build system (including the commands
        that can be used to build the development kit and an application)
        and guidelines for porting an application

    *   Optimizations used in the software and those that should be considered
        for new development

    A glossary of terms is also provided.

*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions,
    data structures and other programming constructs.

*   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
    Each chapter describes a sample application that showcases specific functionality
    and provides instructions on how to compile, run and use the sample application.

*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
    Separate guides exist for each of:

    * :doc:`../bbdevs/index`

    * :doc:`../compressdevs/index`

    * :doc:`../cryptodevs/index`

    * :doc:`../dmadevs/index`

    * :doc:`../eventdevs/index`

    * :doc:`../gpus/index`

    * :doc:`../mempool/index`

    * :doc:`../nics/index`

    * :doc:`../rawdevs/index`

    * :doc:`../regexdevs/index`

    * :doc:`../vdpadevs/index`

error: patch failed: doc/guides/freebsd_gsg/intro.rst:23
Checking patch doc/guides/linux_gsg/doc_roadmap_inc.rst...
Checking patch doc/guides/linux_gsg/intro.rst...
error: while searching for:
Documentation Roadmap
---------------------

The following is a list of DPDK documents in the suggested reading order:

*   :doc:`../rel_notes/index`: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on.
    Also, provides the answers to frequently asked questions in FAQ format.

*   :doc:`../linux_gsg/index` (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software.

*   :doc:`../prog_guide/index`: Describes:

    *   The software architecture and how to use it (through examples), specifically in a Linux application (linux) environment

    *   The content of the DPDK, the build system (including the commands that can be used to build the development kit and
        an application) and guidelines for porting an application

    *   Optimizations used in the software and those that should be considered for new development

    A glossary of terms is also provided.

*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions, data structures and other programming constructs.

*   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
    Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application.

*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
    Separate guides exist for each of:

    * :doc:`../bbdevs/index`

    * :doc:`../compressdevs/index`

    * :doc:`../cryptodevs/index`

    * :doc:`../dmadevs/index`

    * :doc:`../eventdevs/index`

    * :doc:`../gpus/index`

    * :doc:`../mempool/index`

    * :doc:`../nics/index`

    * :doc:`../rawdevs/index`

    * :doc:`../regexdevs/index`

    * :doc:`../vdpadevs/index`

error: patch failed: doc/guides/linux_gsg/intro.rst:12
Applying patch doc/guides/freebsd_gsg/intro.rst with 1 reject...
Rejected hunk #1.
Applied patch doc/guides/linux_gsg/doc_roadmap_inc.rst cleanly.
Applying patch doc/guides/linux_gsg/intro.rst with 1 reject...
Rejected hunk #1.
diff a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst	(rejected hunks)
@@ -23,58 +23,4 @@ handbook is available from the FreeBSD Documentation Project:
 Documentation Roadmap
 ---------------------
 
-The following is a list of DPDK documents in the suggested reading order:
-
-*   :doc:`../rel_notes/index`: Provides release-specific information, including supported
-    features, limitations, fixed issues, known issues and so on.  Also, provides the
-    answers to frequently asked questions in FAQ format.
-
-*   :doc:`../freebsd_gsg/index` (this document): Describes how to install and
-    configure the DPDK; designed to get users up and running quickly with the
-    software.
-
-*   :doc:`../prog_guide/index`: Describes:
-
-    *   The software architecture and how to use it (through examples),
-        specifically in a Linux* application (linux) environment
-
-    *   The content of the DPDK, the build system (including the commands
-        that can be used to build the development kit and an application)
-        and guidelines for porting an application
-
-    *   Optimizations used in the software and those that should be considered
-        for new development
-
-    A glossary of terms is also provided.
-
-*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions,
-    data structures and other programming constructs.
-
-*   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
-    Each chapter describes a sample application that showcases specific functionality
-    and provides instructions on how to compile, run and use the sample application.
-
-*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
-    Separate guides exist for each of:
-
-    * :doc:`../bbdevs/index`
-
-    * :doc:`../compressdevs/index`
-
-    * :doc:`../cryptodevs/index`
-
-    * :doc:`../dmadevs/index`
-
-    * :doc:`../eventdevs/index`
-
-    * :doc:`../gpus/index`
-
-    * :doc:`../mempool/index`
-
-    * :doc:`../nics/index`
-
-    * :doc:`../rawdevs/index`
-
-    * :doc:`../regexdevs/index`
-
-    * :doc:`../vdpadevs/index`
+.. include:: ../linux_gsg/doc_roadmap_inc.rst
diff a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst	(rejected hunks)
@@ -12,50 +12,4 @@ without going deeply into detail.
 Documentation Roadmap
 ---------------------
 
-The following is a list of DPDK documents in the suggested reading order:
-
-*   :doc:`../rel_notes/index`: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on.
-    Also, provides the answers to frequently asked questions in FAQ format.
-
-*   :doc:`../linux_gsg/index` (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software.
-
-*   :doc:`../prog_guide/index`: Describes:
-
-    *   The software architecture and how to use it (through examples), specifically in a Linux application (linux) environment
-
-    *   The content of the DPDK, the build system (including the commands that can be used to build the development kit and
-        an application) and guidelines for porting an application
-
-    *   Optimizations used in the software and those that should be considered for new development
-
-    A glossary of terms is also provided.
-
-*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions, data structures and other programming constructs.
-
-*   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
-    Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application.
-
-*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
-    Separate guides exist for each of:
-
-    * :doc:`../bbdevs/index`
-
-    * :doc:`../compressdevs/index`
-
-    * :doc:`../cryptodevs/index`
-
-    * :doc:`../dmadevs/index`
-
-    * :doc:`../eventdevs/index`
-
-    * :doc:`../gpus/index`
-
-    * :doc:`../mempool/index`
-
-    * :doc:`../nics/index`
-
-    * :doc:`../rawdevs/index`
-
-    * :doc:`../regexdevs/index`
-
-    * :doc:`../vdpadevs/index`
+.. include:: doc_roadmap_inc.rst

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

UNH-IOL DPDK Community Lab