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 8CCAD1580B3 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 C0337E085E; Sat, 4 Sep 2021 10:36:57 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.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 92548E085E 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 84E2F335C07 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 063BD56 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: <1630751712.c2ddff702a72b8240915e8fb583a753670a1a553.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: c2ddff702a72b8240915e8fb583a753670a1a553 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: 44ab3bde-e755-428d-b958-5bff1670a3fa X-Archives-Hash: a02961d0b2fa901c17711f8c123721b2 commit: c2ddff702a72b8240915e8fb583a753670a1a553 Author: Ulrich Müller gentoo org> AuthorDate: Wed Sep 1 18:12:50 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Sat Sep 4 10:35:12 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c2ddff70 eclass-writing: Whitespace Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 184 ++++++++++++------------------------------------ 1 file changed, 46 insertions(+), 138 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 09b41d2..0c81bf6 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -194,120 +194,64 @@ summarizes the available documentation tags: description - - @ECLASS: - - - NO - - - Name of the eclass being documented - + @ECLASS: + NO + Name of the eclass being documented Documents various information about the eclass. Must appear as the first tag in the comment block. - - @MAINTAINER: - - - NO - - - One or more name and email pairs - + @MAINTAINER: + NO + One or more name and email pairs List of maintainers for the eclass to be contacted. One line per maintainer. Must start on a newline after the tag. - - @AUTHOR: - - - YES - - - One or more name and email pairs - + @AUTHOR: + YES + One or more name and email pairs List of authors for the eclass. One line per author. Must start on a newline after the tag. - - @BUGREPORTS: - - - YES - - - Multiline freetext - - - Describes how bugs related to this eclass should be reported - + @BUGREPORTS: + YES + Multiline freetext + Describes how bugs related to this eclass should be reported - - @VCSURL: - - - YES - - - A URI string - - - Points to the URL of the VCS that contains the eclass source - + @VCSURL: + YES + A URI string + Points to the URL of the VCS that contains the eclass source - - @BLURB: - - - NO - - - Single line freetext - + @BLURB: + NO + Single line freetext Contains a short description for the eclass. Must be on the same line with the tag. - - @DESCRIPTION: - - - YES - - - Multiline freetext - - - Long description for the eclass - + @DESCRIPTION: + YES + Multiline freetext + Long description for the eclass - - @EXAMPLE: - - - YES - - - Multiline freetext - - - Examples that illustrate various uses of this eclass - + @EXAMPLE: + YES + Multiline freetext + Examples that illustrate various uses of this eclass @@ -338,15 +282,9 @@ variables are as follows: description - - @ECLASS-VARIABLE: - - - NO - - - Name of the eclass variable to which the documentation applies - + @ECLASS-VARIABLE: + NO + Name of the eclass variable to which the documentation applies This tag applies to eclass specific variables that affect the default behavior of the eclass. Read-only variables, which are @@ -452,30 +390,18 @@ documentation are: description - - @FUNCTION: - - - NO - - - Name of the function to which the documentation block applies - + @FUNCTION: + NO + Name of the function to which the documentation block applies Documents information about an eclass function such as its calling convention etc. Must appear as the first tag in the comment block - - @USAGE: - - - NO - - - List of required and optional arguments to the function - + @USAGE: + NO + List of required and optional arguments to the function List of arguments that the eclass function accepts, specified in the following syntax: <Required arguments> @@ -483,30 +409,18 @@ documentation are: - - @RETURN: - - - * - - - Return value of the function - + @RETURN: + * + Return value of the function

Description for the value returned by the function.

*: Not optional for functions that return a value.

 - - @MAINTAINER: - - - YES - - - Multiline freetext - + @MAINTAINER: + YES + Multiline freetext List of contacts for the eclass function. One line per maintainer. Must start on a newline after the tag. @@ -537,15 +451,9 @@ documentation are: Declares that this function should no longer be used in ebuilds - - @DESCRIPTION: - - - * - - - Multiline freetext - + @DESCRIPTION: + * + Multiline freetext

Long description for the eclass function.

*: Not optional if RETURN: is absent.