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 89B09A04DD; Thu, 19 Nov 2020 15:11:58 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 718BE592C; Thu, 19 Nov 2020 15:11:56 +0100 (CET) Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com [64.147.123.25]) by dpdk.org (Postfix) with ESMTP id 17E944C90 for ; Thu, 19 Nov 2020 15:11:54 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.west.internal (Postfix) with ESMTP id 8846230F; Thu, 19 Nov 2020 09:11:51 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Thu, 19 Nov 2020 09:11:51 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm2; bh= LCWNa+NM5UldXhgY+ep4n6W31h4hdchr3k7HuzyQnw4=; b=dTmjbcofie1jpiGP 4vT3XDv+m/DBpOQgF8QyPCuw1y4bKzKH3fhuAvTIlsyg5iBoxYLpxGGmHL+QKjHZ GCw8jXqwNy44EHnlk0fdp0HK7CfjthuTkDZAiMVU128S+SL96V+y2qVdXMWFIy5b pj0wQJjqGg7G5RFrk5+Nd5k1iFc++SgSnHrOw9fyTboiF7FpHeI7/QNePG2OaELc 5gmrtws7UvHJ+7500FtkndQ3mQ4wMFG5JqFR6LQYZeCaXaQChrlMpAx6dxR6KDWb lr7iwdoBEk3bXCXuDPQgsMjhWHFQjJs7019LsxEfnucm83l6tbmLDVPzGhE6nJiK GtP2Ug== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; bh=LCWNa+NM5UldXhgY+ep4n6W31h4hdchr3k7HuzyQn w4=; b=VjmqlD7vLOHxwkCQYCNrYHq7dlcmFsEBvPGq5bMVuR9JkXJmq+Z9/Ca8n W4X5DhrFpGBLhSIAxAG+yl6pcdacHuumHRGxkdlnsa+w8PPFj3uxf7LtdQQTYaiq /yYM2ZxzJaQirw9C/f6b74JU7ZGdcXjxRFz2ysQjoIRdvPwGQsCFwnxSQ0NDRk3c E+Bb+hL6EC8wGNuFXHRXOhkp46kO9/JR4iGmryaMC/sbMCXTmpJGu6aB1Yy1VJ/n bN1BEsdpxDwtLTkpPNKx0hurpeeBdqi+IhdVq+4An49dxBcR9K/mG0Jjp5EyESL2 270z8jxA1jcNWKu1iUGP6hPGtO2wg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrudefjedgieduucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkfgjfhgggfgtsehtufertddttddvnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepudeggfdvfeduffdtfeeglefghfeukefgfffhueejtdetuedtjeeu ieeivdffgeehnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 8DAB73064AAA; Thu, 19 Nov 2020 09:11:49 -0500 (EST) From: Thomas Monjalon To: "Burakov, Anatoly" , Bruce Richardson Cc: dev@dpdk.org, david.marchand@redhat.com Date: Thu, 19 Nov 2020 15:11:46 +0100 Message-ID: <6361114.o3ApaE1cmG@thomas> In-Reply-To: <20201119122210.GD1829@bricha3-MOBL.ger.corp.intel.com> References: <027ca076ea8e2be6bd76987da23298ffd5db550f.1605782511.git.anatoly.burakov@intel.com> <8a08a33a-b6ab-610e-d0a5-c1dd78bca9ed@intel.com> <20201119122210.GD1829@bricha3-MOBL.ger.corp.intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH] doc: allow sphinx build with no DPDK version X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 19/11/2020 13:22, Bruce Richardson: > On Thu, Nov 19, 2020 at 12:03:11PM +0000, Burakov, Anatoly wrote: > > On 19-Nov-20 11:48 AM, Bruce Richardson wrote: > > > On Thu, Nov 19, 2020 at 11:44:06AM +0000, Burakov, Anatoly wrote: > > > > On 19-Nov-20 11:24 AM, Bruce Richardson wrote: > > > > > On Thu, Nov 19, 2020 at 10:41:56AM +0000, Anatoly Burakov wrote: > > > > > > Currently, when building sphinx documentation, the build will only > > > > > > succeed if being run from the build system, because the conf.py > > > > > > script expects DPDK_VERSION environment variable to be set, and > > > > > > crashes if it is not. > > > > > > > > > > > > However, there are certain external tools (such as sphinx > > > > > > documentation preview extensions for certain IDE's) that use live > > > > > > preview and thus rely on running their own sphinx commands. In these > > > > > > cases, it is useful to permit building sphinx documentation without > > > > > > specifying the DPDK_VERSION environment variable. The version string > > > > > > is the only thing preventing manual sphinx build commands from > > > > > > working. > > > > > > > > > > > > Fix the conf.py to use "None" as a version string in cases when > > > > > > DPDK_VERSION environment variable is not set. > > > > > > > > > > > > Signed-off-by: Anatoly Burakov --- > > > > > > doc/guides/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 > > > > > > deletion(-) > > > > > > > > > > > > diff --git a/doc/guides/conf.py b/doc/guides/conf.py index > > > > > > 9de490e1c4..aceeb62a4f 100644 --- a/doc/guides/conf.py +++ > > > > > > b/doc/guides/conf.py @@ -36,7 +36,7 @@ html_show_copyright = False > > > > > > highlight_language = 'none' -release = environ['DPDK_VERSION'] > > > > > > +release = environ.setdefault('DPDK_VERSION', "None") version = > > > > > > release > > > > > > > > > > Since this is python, we can probably pull the value from the VERSION > > > > > file on the FS if it's not specified in the environment. However, for > > > > > now in terms of solving this problem, this version is ok. > > > > > > > > > > Acked-by: Bruce Richardson > > > > > > > > > > > > > Yes, we could, and i had that thought. I just decided to keep it simple > > > > and not depending on FS layout. If there's consensus that picking it up > > > > from FS is better approach, i can submit a v2. > > > > > > > > > > My view is that it depends on whether you want this considered for 20.11. > > > If so, I'd suggest that a one-line fix is ok for possible inclusion. For > > > 21.02, a fuller solution would probably be better. > > > > > > /Bruce > > > > > > > It would be nice if this was included in 20.11, so i'll leave it as is :) > > > Thought so. Therefore I suggest you also need feedback from Thomas or > David? Adding them on CC... That's OK for me.