Received: by 2002:a05:7412:b130:b0:e2:908c:2ebd with SMTP id az48csp832955rdb; Fri, 17 Nov 2023 14:17:28 -0800 (PST) X-Google-Smtp-Source: AGHT+IGuayaPLwSxRrqn+D/yT0hJshRCkvxgRAwBA5GvuV39lr2SvWSowBWU0GVs1bh3sxSAqkq5 X-Received: by 2002:a05:6a00:2491:b0:6b3:aded:7e9a with SMTP id c17-20020a056a00249100b006b3aded7e9amr937595pfv.27.1700259448122; Fri, 17 Nov 2023 14:17:28 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1700259448; cv=none; d=google.com; s=arc-20160816; b=YKuByWaSfaAwPpTgh7EOW8faWJZgNSlDMYPxVZ0g6kCScnrqzTG/ZqljFMQNATWi6X Iz/R5q9PXsYvmo1MdoEH0gjBMGEO07GOksqQG4HRzPcL0bsaaEbBhctvuUXekxkuV/XU dv+l5etKplapknxjcNHZi7qtc1PO3UEWXZhtTdQyaJi1idb3Ju8zoC5D0gMVnRYwumOy +CMY9Nd+ltaot3YnvhaCDwQXu+WWQAYzP1wrtQ0Yc0+UIgVRQi0zs7hUdyyL1zyIKSZF ZtSabWK3Jgok0aRfgJsB5qKYxy5T55lu9bz1IejGi2VOk8ycUs1ddiG6a0hoUzIPVAnP QF2w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:mime-version:message-id:date:references :in-reply-to:subject:cc:to:from:dkim-signature:dkim-filter; bh=+iMSu9G5yo159Da0W+TlYSAqLVEKQPYPsL87vIzTR0E=; fh=98s8fXCVNv9vv6ZRpgvrHsm51g181USJlTCOSw3uHSs=; b=t4yTlZO9ytF+5Z1zqLUm/YSkbtdxb7pt3NJL8aoC8q0PRDneelD47UVQ2MegcSStn+ DZ00UWF5jFjpmxh4qwstVqvOhhOXgzqrIUhL2TGEgXVuis+HTFfOlTuyWRylMjiKxUuc gG1ok4mXHMCmiYxYHlJQWqXMXsWHLSBoBLK3oj+89CwE6A4PKnWI3lRCuASd5LTTX/PK oQdxBBuXMFB7jaUkf+OWvRzp89zEKV9301SD7GF7++sZv7W+kfOfVMEfB5C2It4ifhND s7oSdSrHxABemBhzAB4slx3alU78Em6Ql7WlOMnYgvlt0IerlBCDmQn9EmzWrtzCS+C/ /sWg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=NYjYoKZi; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from fry.vger.email (fry.vger.email. [23.128.96.38]) by mx.google.com with ESMTPS id g29-20020aa79f1d000000b006b7d62ed178si2669766pfr.5.2023.11.17.14.17.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 17 Nov 2023 14:17:28 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) client-ip=23.128.96.38; Authentication-Results: mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=NYjYoKZi; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.38 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by fry.vger.email (Postfix) with ESMTP id 930268378497; Fri, 17 Nov 2023 14:17:25 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at fry.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231954AbjKQWRS (ORCPT + 99 others); Fri, 17 Nov 2023 17:17:18 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42852 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229823AbjKQWRR (ORCPT ); Fri, 17 Nov 2023 17:17:17 -0500 Received: from ms.lwn.net (ms.lwn.net [IPv6:2600:3c01:e000:3a1::42]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AAEAFB8; Fri, 17 Nov 2023 14:17:13 -0800 (PST) Received: from localhost (unknown [98.53.138.11]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 48BEA2F3; Fri, 17 Nov 2023 22:17:13 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 48BEA2F3 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1700259433; bh=+iMSu9G5yo159Da0W+TlYSAqLVEKQPYPsL87vIzTR0E=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=NYjYoKZifeWoc5EeO5E7HW+n4uJV2C8f/PrKyqy39mTB3ngF8SqierEt7ksjRr2nz VLi6Iquf0yQXoNffLE2BACfc9csSE1zUZE4V3Z06JCgeOvBkMaPYRxNR1JMTRzf/wd AKPcCWqdp9/TBLy6SdyEaIeNErljIPYCUeVtvauG7lztG5AZEEZm18D/HLWYWqPghl YuHXK8RtwnOhMcvhPSkPSJRiQ1HMfBMyHzcFutWc0yNaTH1Tv4VlvDArjlej430S5x Y42VIrJvfC/VwVqwG4pXbUZkBk8R1ugwtH4AKiTWBYla507gwMjEUMFovXbtcm3R7j 47erXVF184XHQ== From: Jonathan Corbet To: Breno Leitao , netdev@vger.kernel.org, donald.hunter@gmail.com, kuba@kernel.org Cc: leit@meta.com, linux-doc@vger.kernel.org, pabeni@redhat.com, edumazet@google.com, linux-kernel@vger.kernel.org Subject: Re: [PATCH v2] Documentation: Document each netlink family In-Reply-To: <20231113202936.242308-1-leitao@debian.org> References: <20231113202936.242308-1-leitao@debian.org> Date: Fri, 17 Nov 2023 15:17:02 -0700 Message-ID: <87y1ew6n4x.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on fry.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (fry.vger.email [0.0.0.0]); Fri, 17 Nov 2023 14:17:25 -0800 (PST) Breno Leitao writes: > This is a simple script that parses the Netlink YAML spec files > (Documentation/netlink/specs/), and generates RST files to be rendered > in the Network -> Netlink Specification documentation page. > > Create a python script that is invoked during 'make htmldocs', reads the > YAML specs located under Documentation/netlink/specs, parses one by one > and generates a correspondent RST file for each YAML file. > > Create a new Documentation/networking/netlink_spec index page, and > reference each Netlink RST file that was processed above in this main > index.rst file. > > In case of any exception during the parsing, dump the error and skip > the file. > > Suggested-by: Jakub Kicinski > Signed-off-by: Breno Leitao In principle I like this approach better. There is one problem, though: - In current kernels, on my machine, "make htmldocs" when nothing has changed takes about 6s to complete. - With this patch applied, it takes a little over 5 *minutes*. Without having delved into it too far, I am guessing that the unconditional recreation of the netlink RST files is causing the rebuild of much of the documentation. Even so, I don't quite get it. That, clearly, would need to be fixed before this can go in. Thanks, jon