[dpdk-dev] [PATCH v6 2/2] doc: add new introduction to sample app guides

Thomas Monjalon thomas at monjalon.net
Sat Oct 14 00:17:12 CEST 2017


Hi,

11/10/2017 17:51, Marko Kovacevic:
> --- a/doc/guides/sample_app_ug/ipsec_secgw.rst
> +++ b/doc/guides/sample_app_ug/ipsec_secgw.rst
> @@ -28,6 +28,8 @@
>      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
>      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
>  
> +.. _sample_app_ipsec_secgw:
> +
>  IPsec Security Gateway Sample Application
>  =========================================
>  
> diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
> index ba64ea2..901603e 100644
> --- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
> +++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
> @@ -28,7 +28,7 @@
>      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
>      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
>  
> -.. _l2_fwd_app_real_and_virtual:
> +.. _sample_app_l2_fwd:
>  
>  L2 Forwarding Sample Application (in Real and Virtualized Environments)
>  =======================================================================

You don't need to add such anchor at the top of a doc.
You can refer to a doc with :doc: tag.
Please do not add more useless anchors.

Idea for another patch: remove all useless anchors at top of files :)


More information about the dev mailing list