From nobody Tue Sep 29 01:18:19 2026 Received: from mail-wm1-f52.google.com (mail-wm1-f52.google.com [209.85.128.52]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EBA333EAC98 for ; Thu, 13 Aug 2026 19:21:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.52 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786648899; cv=none; b=PcAmYIrEctkaK4Bn6Dej9HL6inr6aGIGM96rkIIpdCLYkVY00LHgnzErXND5onAEyatiuQR6yrmTamuiJ/ACKsJLBUF1CiHKoU2duTLTK5zAGFyESH13kY019A92T8bDcFr/22jo+Z/aM9Z0Iweoci7F3cErsUPCLR82IMMD6E0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1786648899; c=relaxed/simple; bh=vv8PV5ubYJpjgCVez8EfNnQ5d2wjNYWxAZbqsZfNvpI=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version; b=WeFTAbltToHoDOtP4kDnu72r6AZPCSoJe449+IK9sejrfxoU9wUi6CVosFlVWKq7zvj5q4mo35KNBs6ZUThnTPMKGpeg9B9Hv63hDX0Y/dlrCLP/o1SguQZJCqI4Asm/pi2NxCFgxDF5AlKaUwaxoMZj0SM2M3iw4vMDu0Hn8Ew= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=gYGS83AU; arc=none smtp.client-ip=209.85.128.52 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="gYGS83AU" Received: by mail-wm1-f52.google.com with SMTP id 5b1f17b1804b1-496bb7cdf51so3860445e9.2 for ; Thu, 13 Aug 2026 12:21:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1786648894; x=1787253694; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to:content-type; bh=+7NB8ynmNItA2zqEEd8ZtdSkai2iXlE7wEPBOLcYnsQ=; b=gYGS83AURLUwgq7r7T6XZKHBJevWsjxH44GPL6VZJr9+bkpOQL77vVDrUg5qT4BPDV QHKC6Wre7EmUlvJ/eiU6QQUVrAJDJ+jLq9F5jpZoKhKDkxrz+3ONdr1yD759csWvSV2F 2E3A4SrFUYBXwI3GCpHUchVlBd0ybGfBc0qwA0xgQvVXW2UM5nTJyQzL7CATcJYnuRVL GyE7GEFQJ0Xn2psjQLvRrtEUlK+MF/D1JVfkT7bcJ+tSnffONrg9AdirDq/Y0uaZh4+j w+fkYXbigSEikTkEyuMWrjDiVWxiCmmbjvIkwuSG0d+ynExtkzQKeTSU9rydQbZqWv// xijA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1786648894; x=1787253694; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to:content-type; bh=+7NB8ynmNItA2zqEEd8ZtdSkai2iXlE7wEPBOLcYnsQ=; b=r8WHwXw6tOI1MkR3TrYVJ43+YHkdmnmCXfGrCKL8vbeeOuO3mKVE9P286MCwa4wnly RR/kcLK1EiVsxgwKKq0qWmAB6vd25ucRqnBkKwdCEBTwsu04cEuGBCtGCJu2/iWiE+/W t0WhJO5PExipLCcR7ZFE77/9e34st78h8Ezth98NrE8u39sFSDysI90QerWHmX1YZQA+ 1B96saCBaMTQb9z19D9fCU/8sJ95qM+p5gkC9aooLqVZClcYpqgz4UuQuVq/fHrn/PLf L2aEK7NqW4X6T1oV6JI3xzbnKBX3vVeXw/SKv2Cftiznqlwn5Fh291x9Jf4tb/Z9w3j4 dZ5A== X-Forwarded-Encrypted: i=1; AHgh+Rori+VjQBHO9Sr0hpEWMmjiwKK4ZANXwcDZS1nQmcpEXOKUhm3Uu3u1T5DoYlvmKRZn9TgZQw7rwlR5M4I=@vger.kernel.org X-Gm-Message-State: AOJu0Yxy4O2YHz380VvMbZAhcm9RqqvKvI7QLIbLon/O6RFxXvMGeD9j VHd5KzS2BwraguRIrdeAqsh2+vf7vsUwf+w7oO2c3x+FOIsleXmBMuAN X-Gm-Gg: AR+sD11tTcTBAZbKHBticUG6lZUzIJ8dH0E4y9W51RtbGLAd6saOiQalPHmBy5UboTU iyNT3uJFMOJQHesXoGxU1KM5NXlnJ2kIkt5Re+pBPzuqL+Di9qIIzZCHHnMYyXGdCdAiODweTQg /mdzZ/wsOvGJoLWBuwiSR6KO9lPGu/2KuRXMtyr8XKwuAeK27DnQYkolXysFooOne2ZyivfwX/5 5wpvl3dW/06phfYj+ROsK4NJqzg/L5eoR56HCqjeT5EWw+5J2ZpbMgNC0nKDaHCgFQhKI/vK2IW 8EaFddKA1NcT8wuGfv4PJQF9Vz3oHH/bgeIqt9vusDnDZtUQBC386YButKA1hOoZFtu5Bma8bUH ZWW5v/in6QCY927+BUHLH9zO9YgU6xSRUtK53KBw+VI1uollgAxQVC3vpEU4inmt+QOPO9vmIro JyNPJgeNVVL1Ae+MtyslVGHEpwld0PeOUEDtM2dbFMzqs6ABbZmfE9+m/r0M4Rf6zOl4o1ENjn6 OWPKuhCW2//EOVaxLnuzbGuvXT5y9CEpNlqnC///L6a8b4Y4yzPOaK5xXFVfTkPOpSYBl0JWspx TwwaX39Wsfn8CoRZ0UIs1rQ7d6qsg/pNZw+w7h440DAC0/v+xog2qPyCU7DHVowQYPuX X-Received: by 2002:a05:600c:228e:b0:495:4e1d:82df with SMTP id 5b1f17b1804b1-499879774bamr6459735e9.10.1786648894179; Thu, 13 Aug 2026 12:21:34 -0700 (PDT) Received: from localhost.localdomain (dynamic-2a02-3100-9c79-1f01-1565-573d-10dc-99f9.310.pool.telefonica.de. [2a02:3100:9c79:1f01:1565:573d:10dc:99f9]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-49983f10469sm57977695e9.11.2026.08.13.12.21.33 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Thu, 13 Aug 2026 12:21:33 -0700 (PDT) From: Karl Mehltretter To: "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni Cc: Karl Mehltretter , Simon Horman , netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH net-next] net_shaper: fix net_shaper_ops kernel-doc Date: Thu, 13 Aug 2026 21:21:31 +0200 Message-Id: <20260813192131.21254-1-kmehltretter@gmail.com> X-Mailer: git-send-email 2.39.5 (Apple Git-154) Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Everything from the "Driver ops vs uAPI" heading onward is dropped from the rendered net_shaper_ops documentation. Older Docutils versions do so silently, while Docutils 0.22 reports the nested headings and adjacent list as invalid. Use bold labels and correct the list indentation. Fixes: 16812d9674d4 ("net_shaper: remove incorrect comment about group leav= es") Fixes: 26bc4cfb1737 ("net_shaper: clarify the kernel API / comments") Assisted-by: Codex:gpt-5.6-sol Signed-off-by: Karl Mehltretter Acked-by: Randy Dunlap Tested-by: Randy Dunlap --- The omission is visible in the current linux-next generated documentation: https://www.kernel.org/doc/html/next/networking/kapi.html#c.net_shaper_ops Tested with Sphinx 9.1.0 and Docutils 0.22.4: make SPHINXDIRS=3Dnetworking htmldocs include/net/net_shaper.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/include/net/net_shaper.h b/include/net/net_shaper.h index 05cb625b0fe54..a2eb616a19fd0 100644 --- a/include/net/net_shaper.h +++ b/include/net/net_shaper.h @@ -73,20 +73,21 @@ struct net_shaper { * Each shaper is uniquely identified within the device with a 'handle' * comprising the shaper scope and a scope-specific id. * - * Driver ops vs uAPI - * ------------------ + * **Driver ops vs uAPI** + * * Members of the driver ops mirror the Netlink uAPI but driver calls do n= ot * map 1:1 to user calls. Drivers need to be careful when assuming that ca= lls * disallowed at the uAPI level will never be made at the driver level. * The shaper core performs automatic reparenting and cleanup, generating * additional calls. Notably: - * - @group calls in the driver facing API may have nodes as leaves (user= is - * only allowed to construct groups with queues as leaves) - * - @group calls may update leaf's parent if the parent is about - * to be removed (re-parenting nodes explicitly is not supported in the= uAPI) * - * Implicit creation - * ----------------- + * - @group calls in the driver facing API may have nodes as leaves (user = is + * only allowed to construct groups with queues as leaves) + * - @group calls may update leaf's parent if the parent is about + * to be removed (re-parenting nodes explicitly is not supported in the = uAPI) + * + * **Implicit creation** + * * Shapers are created implicitly, meaning that @set and @group operations * are called both for existing and new shapers. The driver has to infer * whether the operation is an update or a creation by tracking the handle= s. base-commit: 3205699d79f262412c1be7fc1c04066610d3cd52 --=20 2.53.0