From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id A871DA0508 for ; Thu, 31 Mar 2022 18:30:06 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9FA0E42905; Thu, 31 Mar 2022 18:30:06 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 8E68A410F3 for ; Thu, 31 Mar 2022 18:30:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1648744204; 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=errp1o4UcdZZupwanixJQjurfkVxfs5QAr5jpuOPojQ=; b=Ns8q/IFWKBNye/l2+zRe7WeaWJhqIT386AoXlBuAnDIUxcgCEDWRKb1Nlk3NnkFJ11Bj+d wNvUGdBYj0y5nfTIfLqJOhAwuMzZykBsU5Vw2Fho1COZ3e0RlmsqpO7YY95wq+fSICic4a dvBp1B1TG4g5K/iM7Asww524hPgHeZU= Received: from mail-wr1-f72.google.com (mail-wr1-f72.google.com [209.85.221.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-616-U0mTymvaOIykvNqGqgUx4w-1; Thu, 31 Mar 2022 12:30:02 -0400 X-MC-Unique: U0mTymvaOIykvNqGqgUx4w-1 Received: by mail-wr1-f72.google.com with SMTP id j11-20020adfb30b000000b00205a3f19489so91787wrd.16 for ; Thu, 31 Mar 2022 09:30:02 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent :content-language:to:cc:references:from:subject:in-reply-to :content-transfer-encoding; bh=errp1o4UcdZZupwanixJQjurfkVxfs5QAr5jpuOPojQ=; b=YnoPQDgpXzD0KISbOol6CCaD3dGkVYo8NWCPS0Jd+wuvqpjZx7zCZS2irTemTYFtwq B8PsCNhNAmC6lS0DD4LmYm9cGzb+cYF04Q/rEhIE1qofgwDs3oTEowfYCynzWM55LWkB HBP5Kx3fHrSOSMFgsZeyCxpRYkvMKPsKQwyRyy7akVgSGJmhFZAY0hSnNhheW38wwpFL x+fNcZ6wx0j6tp+2qKIaJ4xQpl/eGlZZCfumcGpxwvAzVAN07j5ErLOcysk5r+aiundn yfko/w9VVzJF0NWUXyl/FPc9x8TyDLMq9uhUzpD4/RTrAynpAOMXwgXs9TnFqFCWqOJ7 30BA== X-Gm-Message-State: AOAM532D0ssi1QxnF3Eac02W7Y14yg9kGTOKmxOqTMO5heoSgZgliCQT fG8Poz/kgTBE5yh4itV1Fd1k1RhXvbO5daIYx1HY1NpIcX9HnkHO9pHIH36rCn5z2um6He4BJQB zunMV8ZY= X-Received: by 2002:a7b:cc0d:0:b0:381:220e:a3a0 with SMTP id f13-20020a7bcc0d000000b00381220ea3a0mr5309942wmh.59.1648744201118; Thu, 31 Mar 2022 09:30:01 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxQFEGBoAFhUUcWjORdxYlzY+yI5jK+mAei4GVwHOMM2jpLWzRHfrtNVw6jd0NvHPWmTVhdHg== X-Received: by 2002:a7b:cc0d:0:b0:381:220e:a3a0 with SMTP id f13-20020a7bcc0d000000b00381220ea3a0mr5309933wmh.59.1648744200908; Thu, 31 Mar 2022 09:30:00 -0700 (PDT) Received: from [192.168.0.36] ([78.19.110.230]) by smtp.gmail.com with ESMTPSA id o17-20020a05600c4fd100b0038cd5074c83sm8198901wmq.34.2022.03.31.09.30.00 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 31 Mar 2022 09:30:00 -0700 (PDT) Message-ID: Date: Thu, 31 Mar 2022 17:29:59 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.7.0 To: Bruce Richardson Cc: dev@dpdk.org, anatoly.burakov@intel.com, stable@dpdk.org References: <20220331132654.314022-1-ktraynor@redhat.com> From: Kevin Traynor Subject: Re: [PATCH] doc: add eal_args.include to toctree In-Reply-To: Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=ktraynor@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 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 On 31/03/2022 14:51, Bruce Richardson wrote: > On Thu, Mar 31, 2022 at 02:26:54PM +0100, Kevin Traynor wrote: >> A warning is observed on RHEL 8.4. >> >> [1/1] Generating html_guides with a custom command >> /root/dpdk/doc/guides/linux_gsg/eal_args.include.rst: >> WARNING: document isn't included in any toctree >> >> Add file to toctree to remove warning. >> >> Fixes: 3ee567cfec37 ("doc: document all EAL parameters in one place") >> Cc: stable@dpdk.org >> >> Signed-off-by: Kevin Traynor >> --- >> doc/guides/linux_gsg/index.rst | 1 + >> 1 file changed, 1 insertion(+) >> >> diff --git a/doc/guides/linux_gsg/index.rst b/doc/guides/linux_gsg/index.rst >> index 16a9a67260..cffa4998d8 100644 >> --- a/doc/guides/linux_gsg/index.rst >> +++ b/doc/guides/linux_gsg/index.rst >> @@ -17,4 +17,5 @@ Getting Started Guide for Linux >> linux_drivers >> build_sample_apps >> + eal_args.include >> linux_eal_parameters >> enable_func > > I think this is a false-positive warning, that shouldn't be fixed in this > way. That file is not one to be put at the top level of the doc - instead > it is included by both freesd and linux gsg guides within the relevant > sections. If we can't suppress this warning, maybe we need to rename the > file to not end with a .rst extension. > Ok, it's not a big deal anyway, RHEL 8.4 is using an old version of sphinx (1.7.6). I can't reproduce on Fedora with a newer version (3.4.3) and no one else seems to see it. I tried to remove the warning with :orphan: but I'm not sure it's that well supported in that version. Removing the .rst doesn't seem like the right thing either. I'm ok to live with the warning on older sphinx. Thanks for replying. Kevin. > /Bruce >