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 2888EA0507; 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 B3E5F410F3; Thu, 31 Mar 2022 18:30:05 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 499E54014F 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=1648744203; 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=bMMi7ywjXRpZAMxNiz5rk+OQvUHdr7dGS+4sg+f5fhVCYq0zqEs0K6oOn1t5eIicwJoZGW NpyVPpwFIIMSa0rmhlS7HkxA5tctDuiNnr3gWaldsAgiGqQRxBn0Hz5WCh9b+Dpt7/ezQI HqDC3YEsGoSMCxa2AJo1wmrmeGNsczo= Received: from mail-wm1-f70.google.com (mail-wm1-f70.google.com [209.85.128.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-131-_hEnvZNFPUyiVDcODeLBpw-1; Thu, 31 Mar 2022 12:30:02 -0400 X-MC-Unique: _hEnvZNFPUyiVDcODeLBpw-1 Received: by mail-wm1-f70.google.com with SMTP id i65-20020a1c3b44000000b00385c3f3defaso67489wma.3 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=QZgJDpIvcdXT6buHBI032q7hRDUeyHyVxhN+ueF5HHT6Nn4wZa51I+SSC2LEpkqfEN 6oW8692t99KDZ3Ud2Z93P44js8fQor0hkFnwfrn9CkFgJkHPUYLb7Mb7umU38MVjPpHS Y9m16wIsY5P7Qx42z2UhfPehA2C/cI+u0BoqX4FJig51+RAYZ7yN6qrsaW9rop12rbT3 DiTZC7yb8ltmTsk6CNQysoCOPw9NwxMv3D7+4AgL1XD7TQ8N2MIcwrXJru43H+avIWyZ jc2/P7xzNyKlnheVTPoPWq7AS4QKa/lskXdeWLmHsklEXmpBSKzjS/QYfkVmh1OUKJ3p jAGQ== X-Gm-Message-State: AOAM531mEx3eX6l3RdTTvvSrBhJIbQ8Uza4l4sRXFKd1Yr3hjorNdHBe MYr2x4wGWeozXQcTuRkF6q/Zcj+jmhzjIAS/uOoMCUAyrcByTYtQg1IPx6YMwLjKsTx8uRpchAe 7v2s= X-Received: by 2002:a7b:cc0d:0:b0:381:220e:a3a0 with SMTP id f13-20020a7bcc0d000000b00381220ea3a0mr5309943wmh.59.1648744201119; 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: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-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 >