Received-SPF: pass (google.com: domain of linux-kernel+bounces-44914-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Message-ID: <63304f6a-d26f-414a-8c92-14d740774379@oracle.com>
Date: Tue, 30 Jan 2024 17:23:36 +0100
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v3] Documentation: Document each netlink family
Content-Language: en-US
To: Breno Leitao <leitao@debian.org>, Jonathan Corbet <corbet@lwn.net>
Cc: Jani Nikula <jani.nikula@linux.intel.com>, kuba@kernel.org,
        "David S. Miller" <davem@davemloft.net>, linux-doc@vger.kernel.org,
        netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
        pabeni@redhat.com, edumazet@google.com
References: <20231121114831.3033560-1-leitao@debian.org>
 <874jevjgvo.fsf@intel.com> <87jznqewa7.fsf@meer.lwn.net>
 <ZbkebMW+xLqNhsoB@gmail.com>
From: Vegard Nossum <vegard.nossum@oracle.com>
Autocrypt: addr=vegard.nossum@oracle.com; keydata=
 xsFNBE4DTU8BEADTtNncvO6rZdvTSILZHHhUnJr9Vd7N/MSx8U9z0UkAtrcgP6HPsVdsvHeU
 C6IW7L629z7CSffCXNeF8xBYnGFhCh9L9fyX/nZ2gVw/0cVDCVMwVgeXo3m8AR1iSFYvO9vC
 Rcd1fN2y+vGsJaD4JoxhKBygUtPWqUKks88NYvqyIMKgIVNQ964Qh7M+qDGY+e/BaId1OK2Z
 92jfTNE7EaIhJfHX8hW1yJKXWS54qBMqBstgLHPx8rv8AmRunsehso5nKxjtlYa/Zw5J1Uyw
 tSl+e3g/8bmCj+9+7Gj2swFlmZQwBVpVVrAR38jjEnjbKe9dQZ7c8mHHSFDflcAJlqRB2RT1
 2JA3iX/XZ0AmcOvrk62S7B4I00+kOiY6fAERPptrA19n452Non7PD5VTe2iKsOIARIkf7LvD
 q2bjzB3r41A8twtB7DUEH8Db5tbiztwy2TGLD9ga+aJJwGdy9kR5kRORNLWvqMM6Bfe9+qbw
 cJ1NXTM1RFsgCgq7U6BMEXZNcsSg9Hbs6fqDPbbZXXxn7iA4TmOhyAqgY5KCa0wm68GxMhyG
 5Q5dWfwX42/U/Zx5foyiORvEFxDBWNWc6iP1h+w8wDiiEO/UM7eH06bxRaxoMEYmcYNeEjk6
 U6qnvjUiK8A35zDOoK67t9QD35aWlNBNQ2becGk9i8fuNJKqNQARAQABzShWZWdhcmQgTm9z
 c3VtIDx2ZWdhcmQubm9zc3VtQG9yYWNsZS5jb20+wsF4BBMBAgAiBQJX+8E+AhsDBgsJCAcD
 AgYVCAIJCgsEFgIDAQIeAQIXgAAKCRALzvTY/pi6WOTDD/46kJZT/yJsYVT44e+MWvWXnzi9
 G7Tcqo1yNS5guN0d49B8ei9VvRzYpRsziaj1nAQJ8bgGJeXjNsMLMOZgx4b5OTsn8t2zIm2h
 midgIE8b3nS73uNs+9E1ktJPnHClGtTECEIIwQibpdCPYCS3lpmoAagezfcnkOqtTdgSvBg9
 FxrxKpAclgoQFTKpUoI121tvYBHmaW9K5mBM3Ty16t7IPghnndgxab+liUUZQY0TZqDG8PPW
 SuRpiVJ9buszWQvm1MUJB/MNtj1rWHivsc1Xu559PYShvJiqJF1+NCNVUx3hfXEm3evTZ9Fm
 TQJBNaeROqCToGJHjdbOdtxeSdMhaiExuSnxghqcWN+76JNXAQLlVvYhHjQwzr4me4Efo1AN
 jinz1STmmeeAMYBfHPmBNjbyNMmYBH4ETbK9XKmtkLlEPuwTXu++7zKECgsgJJJ+kvAM1OOP
 VSOKCFouq1NiuJTDwIXQf/zc1ZB8ILoY/WljE+TO/ZNmRCZl8uj03FTUzLYhR7iWdyfG5gJ/
 UfNDs/LBk596rEAtlwn0qlFUmj01B1MVeevV8JJ711S1jiRrPCXg90P3wmUUQzO0apfk1Np6
 jZVlvsnbdK/1QZaYo1kdDPEVG+TQKOgdj4wbLMBV0rh82SYM1nc6YinoXWS3EuEfRLYTf8ad
 hbkmGzrwcc7BTQROA01PARAA5+ySdsvX2RzUF6aBwtohoGYV6m2P77wn4u9uNDMD9vfcqZxj
 y9QBMKGVADLY/zoL3TJx8CYS71YNz2AsFysTdfJjNgruZW7+j2ODTrHVTNWNSpMt5yRVW426
 vN12gYjqK95c5uKNWGreP9W99T7Tj8yJe2CcoXYb6kO8hGvAHFlSYpJe+Plph5oD9llnYWpO
 XOzzuICFi4jfm0I0lvneQGd2aPK47JGHWewHn1Xk9/IwZW2InPYZat0kLlSDdiQmy/1Kv1UL
 PfzSjc9lkZqUJEXunpE0Mdp8LqowlL3rmgdoi1u4MNXurqWwPTXf1MSH537exgjqMp6tddfw
 cLAIcReIrKnN9g1+rdHfAUiHJYhEVbJACQSy9a4Z+CzUgb4RcwOQznGuzDXxnuTSuwMRxvyz
 XpDvuZazsAqB4e4p/m+42hAjE5lKBfE/p/WWewNzRRxRKvscoLcWCLg1qZ6N1pNJAh7BQdDK
 pvLaUv6zQkrlsvK2bicGXqzPVhjwX+rTghSuG3Sbsn2XdzABROgHd7ImsqzV6QQGw7eIlTD2
 MT2b9gf0f76TaTgi0kZlLpQiAGVgjNhU2Aq3xIqOFTuiGnIQN0LV9/g6KqklzOGMBYf80Pgs
 kiObHTTzSvPIT+JcdIjPcKj2+HCbgbhmrYLtGJW8Bqp/I8w2aj2nVBa7l7UAEQEAAcLBXwQY
 AQIACQUCTgNNTwIbDAAKCRALzvTY/pi6WEWzD/4rWDeWc3P0DfOv23vWgx1qboMuFLxetair
 Utae7i60PQFIVj44xG997aMjohdxxzO9oBCTxUekn31aXzTBpUbRhStq78d1hQA5Rk7nJRS6
 Nl6UtIcuLTE6Zznrq3QdQHtqwQCm1OM2F5w0ezOxbhHgt9WTrjJHact4AsN/8Aa2jmxJYrup
 aKmHqPxCVwxrrSTnx8ljisPaZWdzLQF5qmgmAqIRvX57xAuCu8O15XyZ054u73dIEYb2MBBl
 aUYwDv/4So2e2MEUymx7BF8rKDJ1LvwxKYT+X1gSdeiSambCzuEZ3SQWsVv3gn5TTCn3fHDt
 KTUL3zejji3s2V/gBXoHX7NnTNx6ZDP7It259tvWXKlUDd+spxUCF4i5fbkoQ9A0PNCwe01i
 N71y5pRS0WlFS06cvPs9lZbkAj4lDFgnOVQwmg6Smqi8gjD8rjP0GWKY24tDqd6sptX5cTDH
 pcH+LjiY61m43d8Rx+tqiUGJNUfXE/sEB+nkpL1PFWzdI1XZp4tlG6R7T9VLLf01SfeA2wgo
 9BLDRko6MK5UxPwoYDHpYiyzzAdO24dlfTphNxNcDfspLCgOW1IQ3kGoTghU7CwDtV44x4rA
 jtz7znL1XTlXp6YJQ/FWWIJfsyFvr01kTmv+/QpnAG5/iLJ+0upU1blkWmVwaEo82BU6MrS2 8A==
In-Reply-To: <ZbkebMW+xLqNhsoB@gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: 
	=?utf-8?B?ckM0UVkwWFZSUHdCWDJXRlFJdEZJV1FiUURNNm1WM2VUMzRYU2RuSE9sMC9m?=
 =?utf-8?B?N2dqYkNwWmJoNnhrblc1aHJ0TjlDS0ZmTXJoRlNzWFkwY3YvcHJLYlJjU0I2?=
 =?utf-8?B?WG5ubWxHV2Z3T0ZyVkMwUFNFQ3FsOVBlc3hZdDhHc1pHTFBlTE9lcVY4MTAv?=
 =?utf-8?B?UHVwRWdrbDVTcWNMd0l1WGlTcWJEdEFLYVFPZHI5N3JBRXJTVWs4dFZHeCt0?=
 =?utf-8?B?elpETkVLZWcxOGNCVm9XdlZEVVE1WkZwMnFFWWsvYWZmTit1YStOcjNzZDZQ?=
 =?utf-8?B?SURxQWNHMGRrNU5reWxCYjJ1Y2M2MWd3OVZ3eFRISis4TlZIb1gzQVNhdnhB?=
 =?utf-8?B?VHBZNXhycnIrMDlxMHkvVzY2bnhuWkY1aGdQNlBxQTU2UGk4MFQ5YVhMWTNY?=
 =?utf-8?B?L09SZ3NoSHRWd3pNNHhHN2ZYemd5cGVaNGNQOUVOcngwaTRTRGxZR05LZ21h?=
 =?utf-8?B?azRmSGZJN0xjU0F3TEZWaWF1STJRbkRqTVMyWXl6VlhPait5aWdhUWZSWlpG?=
 =?utf-8?B?YUMvWUY2M3NiL2I2dTlHMTk2b1hVT1krNDdEZEpGRHZIdHN4Ym9DdmJBVTZt?=
 =?utf-8?B?UE5DdG5PUFMwRWovME80SnkrWUVEcDFNNGtYeEx0S0hVUWx3YkZqVUdzazBC?=
 =?utf-8?B?VEVRQVlOMENMZTZRTlUrR0Z4RktXUjJhU25aanpUMUo5SWlpYkNUVXFoa3N4?=
 =?utf-8?B?YkFEdzFxL21ZQ1VZbjZoS2R0clVhSVpueFVPZW5YYUhVM3Y2eGtEeU5QTXVq?=
 =?utf-8?B?Mkp4MzE3NnhmdU1wVWZ1MGFiT1pvV1plbmF1Y01tUlFlQnJ6emp2Q1p0d1g2?=
 =?utf-8?B?cUNFVFFiUTVWelRnOWVWUEJFS2R6S0lEbUJ6OEtrblhHa2xpNmFMYnJvMm9D?=
 =?utf-8?B?RG9EOXlOaDRMM3N5eGEwdUFDK1lLVnFZTEZPVUpRZHBITGJ3b3hBVVhFMkFr?=
 =?utf-8?B?dTBHVVNnU0hJV2czOHljVTQyR0t5RzIxY1h5Yk5QZjhJSnRKWTZFa0xRcy9a?=
 =?utf-8?B?c2lRa1lrMHZyL29DdlI2S2U4dEpHVG02dkwxTEYreU9nTzZYdkdpQXYxdHJw?=
 =?utf-8?B?b0kzNGZad2lRV2liYVI5ZkhrKzRTSzlqdTVOTFNzY0o4ZnVzNmJXalNVSmpm?=
 =?utf-8?B?ME02VXk3SFNMUVNYYTJnS0V6RXNjaDZNTXBTczk3ZFFUMytVcVBOQ0EvQVdP?=
 =?utf-8?B?bitBMk9pVkd3NzJMTUtUMWxxKzZFbXNSQzhnRzNtSDR2dXg0dDVWUDJmalJM?=
 =?utf-8?B?MmludStyVW1CbEN6YWFNK3ZobFZ6eGVIdXhzSHBGeDZQR1gzWFNtbk4zMCtR?=
 =?utf-8?B?OE40QTFmeStyMnBRQmpxbkNBQ3NOR09UdzJjWXJodjFIdDB1MCtJZitqOTJY?=
 =?utf-8?B?WDFQWm1uVnl5MVlIMXJGSDFDL0tPelBpWFdBL1lZR25pbk12SEpEamhFS0Nu?=
 =?utf-8?B?NTNYZDRpODlJQU5jTVNWTDR3UzZlMTdjbCswVWZCM2I1L0tIQUNObENya1Zr?=
 =?utf-8?B?WkUxQ1dJSFoyMHYrdTFheVV6bnUvZDU4eE1DZ0huaTlkM1hHa0RvRlpDMnFB?=
 =?utf-8?B?RCt1MVVxcTR1WEZBRzVieWN0dDVDL2R1RnA2REE3NlBYUVVIVXpIQ3JsYUM3?=
 =?utf-8?B?dUdHVXBPSXBXeWdkWi8xVWE1T0k2UUZrTVhwNWF0c1pSZDVzeklOUitpOEdN?=
 =?utf-8?B?a1R1TFArMk9YeVA0akN5L0hKOTFySkVSZThVQTExcUdXY2tQT2VOendIZTgy?=
 =?utf-8?B?WUkrN0lmOFlnSG1GNi80TzErSjVlVlJLS2oreHg2OGlDdnRpSnBSSlhjNHIr?=
 =?utf-8?B?Nm5sMHMxTWZsQ1pNNVp0bk5zcjVFRkpwSm43cHNhZTNYRWUzTG9GUWtOZTdo?=
 =?utf-8?B?ak8rdmR5a3Q4dy95OEhqMElkQlpGT25xaG1Mam5KK0J2WUltYllISC9KWGFt?=
 =?utf-8?B?TUtuOVI0T2V2VjkvTG80eElPUTZBRlFrK0QxRWE5ZnYvWHFlOE4xcGh0Wk95?=
 =?utf-8?B?Um9HbVZFdEgxNDNMQUZXMGJ3N0NGSWljNmVIQmNod0ZhZjJwUTF4OXp2UEFG?=
 =?utf-8?B?QUdvYzBZcDliZnpVNWw2Q0JSWUNuNklxTFRLTDNGc0M3STZZNnVJdXRXUWhU?=
 =?utf-8?B?a2xjZURPN1RUMGZLWWg2UStNeEVXMzVUZVArSHVIRDZvRUJ3LytTNVF0RHFY?=
 =?utf-8?B?YUE9PQ==?=
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 
	K3vxsMM4gJooKx5EkJj5Yjx4xfx1LT0C533SjjigzJjn5gnuolFRnnDUVnwRXV3vFij2CKNnJW093L9SXnOcNevjgTjbWLsJfMTqONA0SC7I9+YcBA2lH70fJmRRcu58WwdK+/0P5NWCDZmmkFqOwenfSpF6XG5b/qWITqGVMKBWj9Wc3WFuEjYTFZaWR1zgnGt7FqI8OahlxdICB3FLVv5J1saK3xMBLW9T5S5VOeb0riYhrkauBxgBR6vmLQYIZJe9JCwdrUCk5gnrQrfjQn4ixSywPAqcTsOt+g9iBtfgcCtQUCwzLTbIs3Gr72wF5PVOuZJXOgMkGFwiPGESFN1RxYABYnTdyP2Yosb9vDHen7C2IhlWue6Y70FM1qUm7BPfIePKEJD8LJhy6yOmjQTfnHmfSyFthbHB9FN9mPrsjUp4J/SboI9J48+XEm8NaI+khyPS97R5bhC5exd6ZYMi5f84N1iVAmFa3Lspcz6HC82SSffmJ+ytPDwnK1AkLtr7PVZ8OU943jacHoYfLx9haIpE7bUP3N/AxAJ58VIOj7btsgfByNTsmSBNH4k1ieKbu884S4upwUIzigbT3GLsH1RdPapc/U0qcEuEPj0=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d2a72aa3-8a49-44f8-cc44-08dc21afd28c
X-MS-Exchange-CrossTenant-AuthSource: PH0PR10MB5433.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Jan 2024 16:23:41.7759
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: x2IUFt8wUrPZ+Tz2gOIhV3yTkKK5O+HuDo+ebE7HU2J1JQFxfoeTLIfBk9LvrqBIMaVPLWPAdXQcFqszi00GmIjvugB8hr+9TJIeolDTGnQ=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR10MB6101
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.272,Aquarius:18.0.1011,Hydra:6.0.619,FMLib:17.11.176.26
 definitions=2024-01-30_07,2024-01-30_01,2023-05-22_02
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=871 adultscore=0
 bulkscore=0 malwarescore=0 suspectscore=0 phishscore=0 spamscore=0
 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2311290000 definitions=main-2401300121
X-Proofpoint-ORIG-GUID: S10pBbbnre91zn59ESaOjJKaZFC8VOYq
X-Proofpoint-GUID: S10pBbbnre91zn59ESaOjJKaZFC8VOYq


On 30/01/2024 17:06, Breno Leitao wrote:
> On Tue, Jan 30, 2024 at 07:22:08AM -0700, Jonathan Corbet wrote:
>> Jani Nikula <jani.nikula@linux.intel.com> writes:
>>
>>> On Tue, 21 Nov 2023, Breno Leitao <leitao@debian.org> wrote:
>>>> 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.
>>>
>>> First of all, my boilerplate complaint: All extra processing for Sphinx
>>> should really be done using Sphinx extensions instead of adding Makefile
>>> hacks. I don't think it's sustainable to keep adding this stuff. We
>>> chose Sphinx because it is extensible, and to avoid the Rube Goldberg
>>> machine that the previous documentation build system was.
>>
>> So I feel like we've (me included) have kind of sent Breno around in
>> circles on this one.  This *was* implemented as an extension once:
>>
>>    https://lore.kernel.org/netdev/20231103135622.250314-1-leitao@debian.org/
>>
>> At that time it seemed too complex, and I thought that an external
>> script would lead to a simpler implementation overall.  Perhaps I was
>> wrong.
> 
> I think you are correct. I personally _think_ that the external script
> is better, mainly because it is self contained, thus, easier to
> maintain.

 From a cursory look at the two versions, the actual Python code to read
the YAML and write the reST is the same in both cases. (Breno, please
correct me if I'm wrong.)

It should be fairly easy to support both methods by moving most of the
code into a library and then having two thin wrappers around it, one
being a stand-alone command-line script and one being the Sphinx extension.

The stand-alone script could even be put directly in the library code,
just wrapped in "if __name__ == '__main__'".

A stand-alone script might be useful for debugging the output without
invoking the full sphinx-build machinery (i.e. basically having an easy
way to inspect and diff the output when making changes to the code).

Bottom line: This particular thing looks like a false dichotomy to me.

We should still fix the writing of .rst to $(srctree), though --
our use of parse-headers.pl seems to sidestep this by writing the
intermediate .rst output to Documentation/output/, I'll have to look a
bit more closely.


Vegard