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 158E613835A for ; Tue, 30 Mar 2021 06:55:54 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 5255FE088B; Tue, 30 Mar 2021 06:55:53 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (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 3A4EBE088B for ; Tue, 30 Mar 2021 06:55:53 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (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 36BB133E695 for ; Tue, 30 Mar 2021 06:55:52 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 8E6FB63D for ; Tue, 30 Mar 2021 06:55:49 +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: <1617087206.336d16aa5fe8c564a15760659e1670a0e98e58b3.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: 336d16aa5fe8c564a15760659e1670a0e98e58b3 X-VCS-Branch: master Date: Tue, 30 Mar 2021 06:55:49 +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: 40ea7d02-561a-4021-9350-2f16b733be58 X-Archives-Hash: 873ce7d61a140db62e951c144d7de872 commit: 336d16aa5fe8c564a15760659e1670a0e98e58b3 Author: Sam James gentoo org> AuthorDate: Mon Mar 22 06:56:29 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Tue Mar 30 06:53:26 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=336d16aa eclass-writing: add new eclass doc tags for Eclass Function Variables Adds: * @USER_VARIABLE * @INCLUDES_EPREFIX * @DEPRECATED Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 90 +++++++++++++++++++++---------------------------- 1 file changed, 39 insertions(+), 51 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 5a1015f..e8b1474 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -568,12 +568,8 @@ using the following tags: description - - @VARIABLE: - - - NO - + @VARIABLE: + NO Name of the function-specific variable to which the documentation applies. @@ -584,61 +580,53 @@ using the following tags: - - @DEFAULT_UNSET - - - YES - - - - + @USER_VARIABLE + YES + + + This tag describes whether the variable is unsuitable for use in ebuilds, + i.e. if it is solely for user consumption via e.g. make.conf or a similar + mechanism. + + + + @DEFAULT_UNSET + YES + Indicates that this variable is unset by default if not set by the developer. - - @INTERNAL - - - YES - - - - - - Indicates that the variable is internal to the eclass function. - + @INCLUDES_EPREFIX + YES + + Indicates that the variable is a path which has ${EPREFIX} prepended. - - @REQUIRED - - - YES - - - - - - Indicates that this variable must be set by the developer. - + @INTERNAL + YES + + Indicates that the variable is internal to the eclass function. - - @DESCRIPTION: - - - NO - - - Multiline freetext. - - - Long description for the function variable. - + @REQUIRED + YES + + Indicates that this variable must be set by the developer. + + + @DEPRECATED + YES + Optionally, the name of any replacement variable. + Declares that this variable should no longer be used in ebuilds. + + + @DESCRIPTION: + NO + Multiline freetext. + Long description for the function variable.