From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.10]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3B0F324A09; Fri, 22 Dec 2023 17:40:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=intel.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="h1nIouA7" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1703266853; x=1734802853; h=from:to:cc:subject:in-reply-to:references:date: message-id:mime-version; bh=WZamYqzzs9Xmm1nTXwdiLWmcvR3nl+x/q6EpuUCFBfY=; b=h1nIouA7wnAKu6wUtpQtB6slDa5u9J2EAU1s5xRxxlIS1icUoeQ6I5KC gEYJgLNpkPeYppkePfYQJEU59/k+/KFxuH5/JUWLEirKMNwzXseHUvT6v kxoXJGpvt2QLOqjNv8aUDSz4kjdVh4chLbcAiiDihtYgzuqvNsa0k4pws Edgq6BTEOlMGSI3qKhMkR5gfHr3KHrKlLxi1cQCTLkrqW8llKhVgNw0ft zetzWINGE5oI2vP6geehflSQZlxaSe0fTYZUaA/oA2I3/QPxvIWUWXtBW p3YH3MhXAfxgigNrjwr5ZKFk4UPmrFsdsCaPUHNY11dKxjuxGoI45tjmu Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10932"; a="3382952" X-IronPort-AV: E=Sophos;i="6.04,297,1695711600"; d="scan'208";a="3382952" Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by fmvoesa104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Dec 2023 09:40:52 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.04,297,1695711600"; d="scan'208";a="19096588" Received: from yspisare-mobl2.ger.corp.intel.com (HELO localhost) ([10.252.50.156]) by smtpauth.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 22 Dec 2023 09:40:49 -0800 From: Jani Nikula To: Vegard Nossum , Jakub Kicinski Cc: netdev@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Vegard Nossum , Breno Leitao , "David S . Miller" , Jonathan Corbet Subject: Re: [PATCH net-next] Documentation: add pyyaml to requirements.txt In-Reply-To: <20231222133628.3010641-1-vegard.nossum@oracle.com> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20231222133628.3010641-1-vegard.nossum@oracle.com> Date: Fri, 22 Dec 2023 19:40:46 +0200 Message-ID: <87a5q2rv8h.fsf@intel.com> Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain On Fri, 22 Dec 2023, Vegard Nossum wrote: > Commit f061c9f7d058 ("Documentation: Document each netlink family") added > a new Python script that is invoked during 'make htmldocs' and which reads > the netlink YAML spec files. > > Using the virtualenv from scripts/sphinx-pre-install, we get this new > error wen running 'make htmldocs': > > Traceback (most recent call last): > File "./tools/net/ynl/ynl-gen-rst.py", line 26, in > import yaml > ModuleNotFoundError: No module named 'yaml' > make[2]: *** [Documentation/Makefile:112: Documentation/networking/netlink_spec/rt_link.rst] Error 1 > make[1]: *** [Makefile:1708: htmldocs] Error 2 > > Fix this by adding 'pyyaml' to requirements.txt. > > Note: This was somehow present in the original patch submission: > > I'm not sure why the pyyaml requirement disappeared in the meantime. FWIW, not really specific to the patch at hand, but I'd always prefer strictyaml [1] with schemas over plain yaml. You get strict typing and validation of the data during parsing. It's pretty nice, maybe worth looking into here. BR, Jani. [1] https://hitchdev.com/strictyaml/ > > Fixes: f061c9f7d058 ("Documentation: Document each netlink family") > Cc: Breno Leitao > Cc: Jakub Kicinski > Cc: David S. Miller > Cc: Jonathan Corbet > Signed-off-by: Vegard Nossum > --- > Documentation/sphinx/requirements.txt | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt > index 335b53df35e2..a8a1aff6445e 100644 > --- a/Documentation/sphinx/requirements.txt > +++ b/Documentation/sphinx/requirements.txt > @@ -1,3 +1,4 @@ > # jinja2>=3.1 is not compatible with Sphinx<4.0 > jinja2<3.1 > Sphinx==2.4.4 > +pyyaml -- Jani Nikula, Intel