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 79A42A04FF for ; Thu, 31 Mar 2022 15:51:33 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6E28E428F8; Thu, 31 Mar 2022 15:51:32 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by mails.dpdk.org (Postfix) with ESMTP id CEDF04014F; Thu, 31 Mar 2022 15:51:30 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1648734691; x=1680270691; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=u2o/BvD/SN7FzETkBBsYQo0OoH4pLtVnc/EsnUwVt4M=; b=laUZ5H6TTRW2vDi2TDIR9gVcfxlw1ydIOmwFUjhlHAogIW/H4q9t81Zq E+nQv6p5EeURh4Xxs5mWysYYFR2eB06Zlbhl8iePRYc7+NCjDHZ0eknZX TjhUpE0wAHbUjb7Xr7o1mNbYxWhaCB91NiwioO5zczzYhs4Y9gWSYXnV0 5pl5piO401wL/CXiOEj19Vh/SDJBh+6DPVdOLSvB6UUxtqUi2eTalpP5i 54V15x6KjE38UfmLuF7LkKKUZiDr8rKlBDsWywQb4RoUuPqeIAZEUxyIk xFv0Ic+NyQfq4jZmCp9TUXM2cDOli2f0bE18fE5jn6tKoqXIVA57+xWWP g==; X-IronPort-AV: E=McAfee;i="6200,9189,10302"; a="257423469" X-IronPort-AV: E=Sophos;i="5.90,225,1643702400"; d="scan'208";a="257423469" Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 31 Mar 2022 06:51:29 -0700 X-IronPort-AV: E=Sophos;i="5.90,225,1643702400"; d="scan'208";a="720471137" Received: from bricha3-mobl.ger.corp.intel.com ([10.55.133.67]) by orsmga005-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-SHA; 31 Mar 2022 06:51:28 -0700 Date: Thu, 31 Mar 2022 14:51:24 +0100 From: Bruce Richardson To: Kevin Traynor Cc: dev@dpdk.org, anatoly.burakov@intel.com, stable@dpdk.org Subject: Re: [PATCH] doc: add eal_args.include to toctree Message-ID: References: <20220331132654.314022-1-ktraynor@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220331132654.314022-1-ktraynor@redhat.com> 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 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. /Bruce