From nobody Fri Dec 26 04:18:57 2025 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) (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 794433D0A4; Mon, 22 Jan 2024 13:28:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=193.142.43.55 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705930122; cv=none; b=VyAIKQgMrqvMyUgTLfHd7LUgbhH/jiaG5PaS4Rg6lTT9DMpJ76dZhlSW01eg1e5Yctcf1vw0T4/YKNmgPxz+sgCvqmHLLQhpgyJ4bp/fk29UXJSR8S/rIdiZ2OexnHMvM8bb8gYY3aWs7HZ/YuarE7LL0GsMF/Wv/IQJ1AXFWUY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705930122; c=relaxed/simple; bh=wp8CIgOze8zh7UuHcI2z6RuWp2qimi//9CWSfp979X4=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=oLhhKe9cUTYo8saZyt6Hodrr409y3KCIWc3EUkDItLO5jzJaAP4vXM4Y+W2Gyvf5C4YiddfLY93XJdTL12DAK4uIuCdYRLzC/JUOhaky3Hw3dlElDmVQXPnKPtS8fyMjb4iCUcX+cOO9QGKYjCTqibBLhoL4Ah9HYvT7uUM8bSg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de; spf=pass smtp.mailfrom=linutronix.de; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=PIUvxB/S; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=C6DZJtBA; arc=none smtp.client-ip=193.142.43.55 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linutronix.de Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="PIUvxB/S"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="C6DZJtBA" From: Anna-Maria Behnsen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1705930119; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=GvZno+kHevh2g23gq9x/FGgfnjZz8motFDnpxT/9ixo=; b=PIUvxB/SYWMC8waUFFQ7/UC2TVIVHS+BH/I6SQhE+1L70dC+9ZPyKzdZhFTB3x60g7BVCu 1PWjW9qZq7hOmAhcvV9z8N1CvviF0sjarzJAL5i1XiZ16cucMP0CkAqNc+qMg6my4wPxle 4ZixEKLw1ewCs7xsmJ1rKPrDZfpmW7+LAIRQPx2T5HLnD6CyzU2Z87A9uxWSLZCeF5BsYA wjmSyhLW7f/o7RddiCzSwOv8OtWuW7xk78UHg4bqGXlxPsNkItbg2rzpPPaqPLCNxLwO3r 68iF+TRZHPBmfEVSiztgrvnirt+MG+MnyhmYTJDqMH3Qr9sTEqU4mDH3+2NFGA== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1705930119; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=GvZno+kHevh2g23gq9x/FGgfnjZz8motFDnpxT/9ixo=; b=C6DZJtBAz6GjBt4Hm9vjPbPUg4cy/VfW0WLxpMGcR+y85IU70jGFMPJmYXYx07ZV2x5jOM Q0oXOLBh739O2ZCQ== To: linux-doc@vger.kernel.org Cc: Jonathan Corbet , Thomas Gleixner , Ingo Molnar , Borislav Petkov , x86@kernel.org, Mike Rapoport , Herbert Xu , "David S. Miller" , Marco Elver , Alexander Potapenko , Shuah Khan , Johannes Berg , Moritz Fischer , Wu Hao , Xu Yilun , Dipen Patel , Philipp Zabel , Heikki Krogerus , David Airlie , Daniel Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , Jiri Kosina , Benjamin Tissoires , linux-kernel@vger.kernel.org, Anna-Maria Behnsen Subject: [PATCH 2/2] Documentation: Remove deprecated kernel-doc option 'functions' Date: Mon, 22 Jan 2024 14:28:20 +0100 Message-Id: <20240122132820.46633-3-anna-maria@linutronix.de> In-Reply-To: <20240122132820.46633-1-anna-maria@linutronix.de> References: <20240122132820.46633-1-anna-maria@linutronix.de> 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" As there are no more users of deprecated kernel-doc option 'functions', rem= ove the related parts in documentation and scripts. Signed-off-by: Anna-Maria Behnsen --- Documentation/doc-guide/kernel-doc.rst | 3 --- Documentation/sphinx/kerneldoc.py | 5 ----- 2 files changed, 8 deletions(-) diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-gui= de/kernel-doc.rst index 6ad72ac6861b..74d6408abcd3 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -505,9 +505,6 @@ no-identifiers: *[ function/type ...]* .. kernel-doc:: lib/bitmap.c :no-identifiers: bitmap_parselist =20 -functions: *[ function/type ...]* - This is an alias of the 'identifiers' directive and deprecated. - doc: *title* Include documentation for the ``DOC:`` paragraph identified by *title* in *source*. Spaces are allowed in *title*; do not quote the *title*. The *= title* diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerne= ldoc.py index 7acf09963daa..2d57c464c76a 100644 --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -53,7 +53,6 @@ class KernelDocDirective(Directive): 'internal': directives.unchanged, 'identifiers': directives.unchanged, 'no-identifiers': directives.unchanged, - 'functions': directives.unchanged, } has_content =3D False =20 @@ -74,10 +73,6 @@ class KernelDocDirective(Directive): =20 tab_width =3D self.options.get('tab-width', self.state.document.se= ttings.tab_width) =20 - # 'function' is an alias of 'identifiers' - if 'functions' in self.options: - self.options['identifiers'] =3D self.options.get('functions') - # FIXME: make this nicer and more robust against errors if 'export' in self.options: cmd +=3D ['-export'] --=20 2.39.2