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 D422613835B for ; Tue, 30 Mar 2021 06:55:53 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 287F3E0885; 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 0C098E0885 for ; Tue, 30 Mar 2021 06:55:53 +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 158A733BE5A 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 6953363B 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: <1617087205.3d47a2bc63aec2ac36b63eae6b84905487f6ddd6.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: 3d47a2bc63aec2ac36b63eae6b84905487f6ddd6 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: a784bab3-ebdc-48b4-9438-57d8bd1ee552 X-Archives-Hash: c8037c7af02038cbd218e0a36f61de17 commit: 3d47a2bc63aec2ac36b63eae6b84905487f6ddd6 Author: Sam James gentoo org> AuthorDate: Mon Mar 22 06:37:51 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Tue Mar 30 06:53:25 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3d47a2bc eclass-writing: add new eclass doc tags for Eclass Variables Adds: * @PRE_INHERIT * @USER_VARIABLE * @OUTPUT_VARIABLE * @INCLUDES_EPREFIX * @DEPRECATED Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 87 ++++++++++++++++++++++++++++--------------------- 1 file changed, 50 insertions(+), 37 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index df02827..b7fd988 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -350,61 +350,74 @@ variables are as follows: + @PRE_INHERIT + YES + - @DEFAULT_UNSET + This tag describes whether the variable must be defined before + the eclass is inherited. This is important if any e.g. dependencies + are modified in global scope at the point of sourcing. + + + @USER_VARIABLE + YES + - 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. + + + @OUTPUT_VARIABLE + YES + - + This tag indicates that the variable's value (which will be set by the + eclass) should be read within an ebuild. + + + @DEFAULT_UNSET + YES + Indicates that this variable is unset by default if not set by the developer. + @INCLUDES_EPREFIX + YES + - @INTERNAL - - - YES - - - - - - Indicates that the variable is internal to the eclass. + Indicates that the variable is a path which has ${EPREFIX} prepended to it. - - @REQUIRED - - - YES - - - - - - Indicates that this variable must be set by the developer. - + @INTERNAL + YES + + Indicates that the variable is internal to the eclass. - - @DESCRIPTION: - - - NO - - - Multiline freetext. - - - Long description for the eclass 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 eclass variable.