From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id 28A861B599; Mon, 17 Dec 2018 08:36:03 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id wBH7a2Xa017071; Mon, 17 Dec 2018 16:36:02 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 7D1A3EA7FFE; Mon, 17 Dec 2018 16:36:02 +0900 (JST) Received: from jcms-pop21.ecl.ntt.co.jp (jcms-pop21.ecl.ntt.co.jp [129.60.87.134]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 727E2EA741D; Mon, 17 Dec 2018 16:36:02 +0900 (JST) Received: from [IPv6:::1] (watercress.nslab.ecl.ntt.co.jp [129.60.13.73]) by jcms-pop21.ecl.ntt.co.jp (Postfix) with ESMTPSA id 6DB2D4007FE; Mon, 17 Dec 2018 16:36:02 +0900 (JST) References: <2655191.rBOfXtWzeA@xps> <54858905-3c47-2636-080a-55799c18e2cf@lab.ntt.co.jp> <1704380.LblYpThBnZ@xps> From: Yasufumi Ogawa Message-ID: Date: Mon, 17 Dec 2018 16:33:31 +0900 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.4.0 MIME-Version: 1.0 In-Reply-To: <1704380.LblYpThBnZ@xps> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-CC-Mail-RelayStamp: 1 To: Thomas Monjalon Cc: Ferruh Yigit , dpdk-web , dpdk-spp X-TM-AS-MML: disable X-Mailman-Approved-At: Mon, 17 Dec 2018 11:34:50 +0100 Subject: Re: [dpdk-web] SPP documentation update on dpdk.org X-BeenThere: web@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK website maintenance List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 17 Dec 2018 07:36:04 -0000 >>> Hi, >>> >>> 10/12/2018 17:52, Yasufumi Ogawa: >>>>> Hi Thomas, >>>>> >>>>> Yasufumi was asking how to update SPP documentation on dpdk.or >>>>> (https://doc.dpdk.org/spp/). >>>>> >>>>> Is there something triggered automatically when a document patch applied? Or is >>>>> it needs to be done manually? How can we manage this doc update? >>>> Hi Ferruh, Thomas, >>>> >>>> Thanks Ferruh for your support! I aske Thomas for documentation and he kindly told me how it is updated with his script. It >>>> might be my fault because of some of compilation errors of documentation. >>>> >>>> I have tried to fix the errors and push to it with new version tag. >> Thomas, >> >> Thank you so much for fixing my problems! >>> >>> First issue I see is the error number: >>> in v18.08 it is defined as VERSION := 18.05.1 >>> >>> Second issue: >>> WARNING: The config value `version' has type `bytes', defaults to `str'. >>> WARNING: The config value `release' has type `bytes', defaults to `str'. >>> >>> There is a third issue with the output of the make command: >>> make: Entering directory '...' >>> 18.08 >>> make: Leaving directory '...' >> I was curious `make showversion` because make command told me that `-r` is illegal even if giving options same as DPDK and no >> warnings for compiling DPDK's documentation. >> >> By the way, do you use python3 for sphinx-build? I am using python2 and there are no warnings in the second issue while docs >> compilation. If so, I should update to python3 to be the same environment as yours. > > I use python3 but the server dpdk.org uses python2. > >>> Last but not the least, the doc will be generated only when you push an annotated tag: >>> git tag -am spp-18.08 v18.08 >> I understand pushing tag is also incorrect. I simply added the tag and pushed. >> $ git tag v18.08 >> $ git push origin v18.08 > > This does not trigger compilation of the doc. > You must use *annotated* tags. Hi Thomas, I tried to add annotated tag for v18.08.1 and push to the repository after applied your patch. However, it does not seem to be working. I confirmed the version number is defined in GNUmakefile as 'VERSION := 18.08.1', and added annotated tag. Here is a result of 'git show' in which annotation is found. Could you give me advice? $ git show v18.08.1 tag v18.08.1 Tagger: Yasufumi Ogawa Date: Fri Dec 14 03:50:38 2018 -0800 spp-18.08.1 commit 5e859023a12d66fe6cd47f45a0d7f909beb47245 Author: Yasufumi Ogawa Date: Thu Dec 13 22:28:47 2018 -0800 ... Thanks, Yasufumi > >> Thanks, >> Yasufumi >>> >>> I fixed all above 3 issues, sent the patch, and updated the doc on dpdk.org.