From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8D966A2F6B for ; Tue, 8 Oct 2019 12:05:23 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4E8741C43E; Tue, 8 Oct 2019 12:05:23 +0200 (CEST) Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [207.211.31.81]) by dpdk.org (Postfix) with ESMTP id 9C1951C1B1 for ; Tue, 8 Oct 2019 12:05:19 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1570529119; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HuvbLlZKBdB0h3tA6rj8xInYo6VRa9r5rf4khpV+9q0=; b=WCrh2sh0DrQGs6J1xO0Vxn1lupoR/aeyEOejRRgJbUSNg3vok0Rz0tn8VQLWoyCEECXN2n MN+R9qsebbCFivngZuISUdMFK3PY+OuVjsitNYUNYNDbGqkxRkMLmnKhAz6Z9VVW/uPNfw 4uGnjoXayUOCCK76uhASCbQjar5rtwA= Received: from mail-vk1-f198.google.com (mail-vk1-f198.google.com [209.85.221.198]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-353-xw_16ab1OQ-X5k1ULokYow-1; Tue, 08 Oct 2019 06:05:17 -0400 Received: by mail-vk1-f198.google.com with SMTP id n124so8041925vkg.13 for ; Tue, 08 Oct 2019 03:05:17 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=g5b60PbTd2OSDo+eDMvXogsu6LFxlN1xnJjReF/HdgA=; b=ZtKnHp+Z+0ZDVrDMZ0/ISa7uXUmcgRxcl/s6PqQGCgkghewTf3h3znHzlX5Wby5vrL TVvggVj0T4PZmFUvap7ynW7GdU2fcktlFyZolAkhvBEnP9CbHvfVOVX2+ab9gMvxkvzE 2LjQPrfDYIXlSRPfw1BySw7J+hPc90/0yAd23bc5SSz/sLswPQCZgwLj3iOmK1ocdKNR ENihEf6mDeTb6tkijnCaAcCUavgurlIh9GywOI9M/h9nk+8nqRaQzHFp4gvCrdi2AtIP 4Boi8g7pGa/J31G+s+Dn2spyzRGS2B40hq6JOB20wJyQqpeSJiYWPzFi5IeVyqRRUdUL AmCg== X-Gm-Message-State: APjAAAUfmBsEdMkDSekPPZXIvA0FcNG+RgAQgaI1WOApYKCh8PcWfMMN E57acDh1Hn6/GccAlUngXSRrHlLuom0UH6s6sqYMSyXYVLVgpMIXtjg2Grh2L/g9DhH729soqDV ji+LBzhOSPpqt0e64qGr2kr0= X-Received: by 2002:a67:fbd8:: with SMTP id o24mr18001886vsr.180.1570529116576; Tue, 08 Oct 2019 03:05:16 -0700 (PDT) X-Google-Smtp-Source: APXvYqxtwc8iHK6rcKcCW6W0qUcrWvFzGzWsE0JSvYhU8dKrtkCxD9VGmuJIK6wuo+Z3n4LC1UpGzhAL3hVU6gqPii8= X-Received: by 2002:a67:fbd8:: with SMTP id o24mr18001870vsr.180.1570529116268; Tue, 08 Oct 2019 03:05:16 -0700 (PDT) MIME-Version: 1.0 References: <86cab83a7628da576933f5f6267abe600b2ae604.1565695422.git.dekelp@mellanox.com> In-Reply-To: <86cab83a7628da576933f5f6267abe600b2ae604.1565695422.git.dekelp@mellanox.com> From: David Marchand Date: Tue, 8 Oct 2019 12:05:05 +0200 Message-ID: To: Dekel Peled Cc: Wenzhuo Lu , Jingjing Wu , "Iremonger, Bernard" , "Mcnamara, John" , "Kovacevic, Marko" , "Burakov, Anatoly" , dev , dpdk stable X-MC-Unique: xw_16ab1OQ-X5k1ULokYow-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [dpdk-stable] [PATCH] doc: fix description of links to EAL options pages X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" Nit: this patch title does not reflect what the issue was. Hard to tell when just looking at it what the impact of your patch is. On Tue, Aug 13, 2019 at 1:26 PM Dekel Peled wrote: > > Documentation includes separate pages of EAL command-line options for > Linux and for FreeBSD. > Links to these pages use the same text 'EAL parameters', so it is not > clear which link to use for which environment. > > This patch adds the text '(Linux)' and '(FreeBSD)' where relevant, to > clearly identify the links. > > Fixes: 3ee567cfec37 ("doc: document all EAL parameters in one place") > Cc: stable@dpdk.org > > Signed-off-by: Dekel Peled > --- > doc/guides/sample_app_ug/intro.rst | 6 +++--- > doc/guides/testpmd_app_ug/run_app.rst | 6 +++--- > 2 files changed, 6 insertions(+), 6 deletions(-) > > diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_u= g/intro.rst > index 9070419..1b19cd1 100644 > --- a/doc/guides/sample_app_ug/intro.rst > +++ b/doc/guides/sample_app_ug/intro.rst > @@ -15,9 +15,9 @@ Running Sample Applications > > Some sample applications may have their own command-line parameters desc= ribed in > their respective guides, however all of them also share the same EAL par= ameters. > -Please refer to :doc:`../linux_gsg/linux_eal_parameters` or > -:doc:`../freebsd_gsg/freebsd_eal_parameters` for a list of available EAL > -command-line options. > +Please refer to :doc:`../linux_gsg/linux_eal_parameters` (Linux) or > +:doc:`../freebsd_gsg/freebsd_eal_parameters` (FreeBSD) for a list of ava= ilable > +EAL command-line options. Adding this text after the link itself is odd: in the resulting documentation, we still have two links named the same. How about renaming the links? Something like: Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>` or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` = for a list of available EAL command-line options. Thanks. --=20 David Marchand