From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id B1D381580B4 for ; Sat, 4 Sep 2021 10:36:58 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id C2A01E0898; Sat, 4 Sep 2021 10:36:57 +0000 (UTC) Received: from smtp.gentoo.org (mail.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id A00EFE0898 for ; Sat, 4 Sep 2021 10:36:57 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 8ACB3335D07 for ; Sat, 4 Sep 2021 10:36:56 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 1946998 for ; Sat, 4 Sep 2021 10:36:55 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1630751713.b691f696abfbc33a4e3f3bea2100ebc466c24e6b.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: eclass-writing/ X-VCS-Repository: proj/devmanual X-VCS-Files: eclass-writing/text.xml X-VCS-Directories: eclass-writing/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: b691f696abfbc33a4e3f3bea2100ebc466c24e6b X-VCS-Branch: master Date: Sat, 4 Sep 2021 10:36:55 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 8400a64b-d2a5-4f12-96dc-120405a3248d X-Archives-Hash: ac67ae0a4b9f181724782af811bd8a2b commit: b691f696abfbc33a4e3f3bea2100ebc466c24e6b Author: Ulrich Müller gentoo org> AuthorDate: Thu Sep 2 07:54:21 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Sat Sep 4 10:35:13 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b691f696 eclass-writing: More documentation tags @SUBSECTION, @SUPPORTED_EAPIS, @PROVIDES, and @DEPRECATED. Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 0c81bf6..791a2ce 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -151,10 +151,11 @@ each block documents an individual element of an eclass.

Documentation tags for various eclass elements are explained in their -respective sections below. Common to all the tags that accept -multiline freetext, the @CODE tag should be used when necessary -to create unformatted code chunks (such as example code) by placing -the tag at the beginning and the end. +respective sections below. Common to all the tags that accept multiline +freetext, the @CODE tag should be used when necessary to create +unformatted code chunks (such as example code) by placing the tag at the +beginning and the end. The @SUBSECTION tag inserts a subsection +heading; it is allowed only in the main @DESCRIPTION.

@@ -232,6 +233,21 @@ summarizes the available documentation tags: A URI string Points to the URL of the VCS that contains the eclass source + + @SUPPORTED_EAPIS: + YES + Space-separated list of EAPIs + List of EAPIs supported by this eclass + + + @PROVIDES: + YES + Space-separated list of eclass names + + List of indirectly inherited eclasses whose functions and variables may be + used by an ebuild inheriting this eclass + + @BLURB: NO @@ -241,6 +257,12 @@ summarizes the available documentation tags: line with the tag. + + @DEPRECATED: + YES + Replacement (or "none") + Declares that this eclass should no longer be used + @DESCRIPTION: YES