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 DA09913835A 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 DCCDBE0891; 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 C5A94E0891 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 6459A340970 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 7BCD963C 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.b80285bdc37a51a2628bf4b7edd44717c15062cb.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: b80285bdc37a51a2628bf4b7edd44717c15062cb 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: 23dfb4be-7f23-4ebc-826c-0a6f568b23e3 X-Archives-Hash: 7fe1084ddd61896d9d3ec683a583dab0 commit: b80285bdc37a51a2628bf4b7edd44717c15062cb Author: Sam James gentoo org> AuthorDate: Mon Mar 22 06:44:06 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=b80285bd eclass-writing: add new eclass doc tags for Eclass Functions Adds: * @INCLUDES_EPREFIX * @DEPRECATED Signed-off-by: Sam James gentoo.org> Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index b7fd988..5a1015f 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -508,20 +508,29 @@ documentation are: + @INCLUDES_EPREFIX + YES + - @INTERNAL - - - YES - - - + Indicates whether the function returns a path with ${EPREFIX} prepended + to it. + + + @INTERNAL + YES + Indicates that the function is internal to the eclass and should not be called from outside. + + @DEPRECATED + YES + Optionally, the name of a replacement function. + Declares that this function should no longer be used in ebuilds. + @DESCRIPTION: