From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) (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 1E9963AA9F4; Fri, 29 May 2026 07:42:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=185.246.84.56 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1780040545; cv=none; b=FKpqfeElxGjz33MjQ7aVhfWuwP45lRPE7sWbSxt6pakwMzE/tmnuXYZRjygvquxHTae+8YxNvk80TjLuTIbcT5ni7W6gOF6nEond3t+kTP1mkmmH8AbWVNioNfohAAfaU88/FF8qVt8jUA6k25nqQBkz2nzHYtt6r3rMJijdEf4= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1780040545; c=relaxed/simple; bh=DhCLGMOZL/w8aCkBuXuDq7mP31RtxM9KjJ0TJxr/Dn0=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=LShVhnqEMmKBrqubD3AvLDdkLtdhWqie0iaRlR1dKrVg8y1DVmj+23IC42hevxE/dVRAEgAJcLlpxbem/+TpHsFPZNUWMfavMWv631s7UpIwEUiaXn7AYhV6SwCTtw8xYLupQMcflhdPq7ZRlSvv0GiK/nUJmw4FgSP6gXLtraI= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=bootlin.com; spf=pass smtp.mailfrom=bootlin.com; dkim=pass (2048-bit key) header.d=bootlin.com header.i=@bootlin.com header.b=t9kFSCYy; arc=none smtp.client-ip=185.246.84.56 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=bootlin.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=bootlin.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=bootlin.com header.i=@bootlin.com header.b="t9kFSCYy" Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id 82AF61A372D; Fri, 29 May 2026 07:42:19 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 56946601FA; Fri, 29 May 2026 07:42:19 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 058F310888CBE; Fri, 29 May 2026 09:42:14 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1780040538; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:content-language:in-reply-to:references; bh=DZ3lfW7SRE9G4rYU9VyZ9PvQOFu+n80p9zGN3rx2H18=; b=t9kFSCYyYsX7Mpm/43AyGd8fYnebRyCopT4YVv1WlV2yeqIP2xi7Z4lzM/NGEDpKfEflqo COl1/50F/BMd2U8vhv2JtY7i/yUoh2uduIOBevb8aCBASp3YSXaTrXbHHEJB/19pHpLnaH wuAz+Ei6HtEaxLhFX537DXLu6YVHHtGiyvXTuvIHiMQM8cxSNsScAflkJ5qQEfnLQIiXC7 n/3x9H1RNTntXn2X0fkVHy/1cR6GS/qtm3cOdKcYM89ZkOOZL4kRAEQnC/bknpD4gb0ljv z+90+AwCWwAm2EBd+1dvFrNzaTpWDqoAgPa3KRqzQ8o3LjME2S0L/hhrb7D4Yw== Message-ID: Date: Fri, 29 May 2026 09:42:14 +0200 Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH net-next] Documentation: networking: Add a test plan for ethtool pause validation To: Jakub Kicinski , Andrew Lunn Cc: davem@davemloft.net, Eric Dumazet , Paolo Abeni , Simon Horman , Russell King , Heiner Kallweit , Jonathan Corbet , Shuah Khan , Oleksij Rempel , Vladimir Oltean , Florian Fainelli , thomas.petazzoni@bootlin.com, netdev@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org References: <20260522175109.198059-1-maxime.chevallier@bootlin.com> <20260526172447.10ca4b9e@kernel.org> <5cb8e2b4-8eb6-4446-9b90-1cd4c7964cd9@lunn.ch> <20260527162516.0d012503@kernel.org> Content-Language: en-US From: Maxime Chevallier In-Reply-To: <20260527162516.0d012503@kernel.org> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Last-TLS-Session-Version: TLSv1.3 Hi On 5/28/26 01:25, Jakub Kicinski wrote: > On Wed, 27 May 2026 04:47:47 +0200 Andrew Lunn wrote: >>> It'd be great to hear from others but IMHO in the current form this is >>> not suitable for Documentation/networking/ We can commit the "knowledge" >>> part but enumerating the test cases seems odd for Documentation/. >> >> Sorry, not looked too deeply at the actual content yet. >> >> What i was thinking was a python file, which sphinx can ingest to >> produce documentation, and place holders were code would be added to >> implement the actual test during the next phase. >> >> This is how i've done testing in the past. I would be the evil one who >> thought up the tests and described them in detail using sphinx markup >> in a python test template file. After some review they got passed off >> to a python developer for implementation. And when they got run and >> failed, sometimes the feature developer, the test developer and myself >> got together to figure who made the error. >> >> I'm not sure we even need sphinx. What i find important is that the >> test is documented. What kAPI calls should be made with what >> parameters. What results we are expected and why? So that when a test >> fails, a developer has the information they need to fix their >> code. The Why? is important, and often missing from the kernel tests. > > All makes sense. The question is primarily how we fit that into > the existing project layout we have in the kernel :( > > The python tests can be hacked up to print the test case docstring > before the failure. > > But I think for human and AI reviewer consumption it may be nice > to keep the condensed knowledge / common mistakes in Documentation/ > If we had the ability to exercise the submissions it'd be a different > story test output would be a sufficient signal and/or could be fed into > the review. But for AI making a guess at whether the submitted driver is > correct purely from the driver source - knowledge is useful. Also for the knowledge part, we had Oleksij's series that documented more aspects of flow control (not just the pause part) : https://lore.kernel.org/netdev/20260304094811.2779953-1-o.rempel@pengutronix.de/ Oleksij, maybe we can merge some of the information here with your doc for the Docuentation/networking part ? Maxime