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 A6DEB1382C5 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 8310FE088D; 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 5ABF1E088D 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 43AE833FD3F 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 B39A563F 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: <1617087329.dbade96ef1200896733d0ec6842f7d82b0f645b3.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: dbade96ef1200896733d0ec6842f7d82b0f645b3 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: f52e0d2e-3edf-411d-b6d6-e26d4c793bf3 X-Archives-Hash: 3730ec31bd1cf19ddac459ac0af3fa98 commit: dbade96ef1200896733d0ec6842f7d82b0f645b3 Author: Ulrich Müller gentoo org> AuthorDate: Tue Mar 30 06:55:29 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Tue Mar 30 06:55:29 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dbade96e eclass-writing: Remove full stop from table entries ::appendices/devbook-guide/#External Coding Style Signed-off-by: Ulrich Müller gentoo.org> eclass-writing/text.xml | 86 ++++++++++++++++++++++++------------------------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 094f939..cc703cc 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -201,7 +201,7 @@ summarizes the available documentation tags: NO - Name of the eclass being documented. + Name of the eclass being documented Documents various information about the eclass. Must appear as the @@ -216,7 +216,7 @@ summarizes the available documentation tags: NO - One or more name and email pairs. + One or more name and email pairs List of maintainers for the eclass to be contacted. One line per @@ -231,7 +231,7 @@ summarizes the available documentation tags: YES - One or more name and email pairs. + One or more name and email pairs List of authors for the eclass. One line per author. Must start on @@ -246,10 +246,10 @@ summarizes the available documentation tags: YES - Multiline freetext. + Multiline freetext - Describes how bugs related to this eclass should be reported. + Describes how bugs related to this eclass should be reported @@ -260,10 +260,10 @@ summarizes the available documentation tags: YES - A URI string. + A URI string - Points to the URL of the VCS that contains the eclass source. + Points to the URL of the VCS that contains the eclass source @@ -274,7 +274,7 @@ summarizes the available documentation tags: NO - Single line freetext. + Single line freetext Contains a short description for the eclass. Must be on the same @@ -289,10 +289,10 @@ summarizes the available documentation tags: YES - Multiline freetext. + Multiline freetext - Long description for the eclass. + Long description for the eclass @@ -303,10 +303,10 @@ summarizes the available documentation tags: YES - Multiline freetext. + Multiline freetext - Examples that illustrate various uses of this eclass. + Examples that illustrate various uses of this eclass @@ -345,7 +345,7 @@ variables are as follows: NO - Name of the eclass variable to which the documentation applies. + Name of the eclass variable to which the documentation applies This tag applies to eclass specific variables that affect the @@ -371,7 +371,7 @@ variables are as follows: 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. + mechanism @@ -380,7 +380,7 @@ variables are as follows: This tag indicates that the variable's value (which will be set by the - eclass) should be read within an ebuild. + eclass) should be read within an ebuild @@ -389,7 +389,7 @@ variables are as follows: Indicates that this variable is unset by default if not set by the - developer. + developer @@ -397,32 +397,32 @@ variables are as follows: YES - Indicates that the variable is a path which has ${EPREFIX} prepended to it. + Indicates that the variable is a path which has ${EPREFIX} prepended to it @INTERNAL YES - Indicates that the variable is internal to the eclass. + Indicates that the variable is internal to the eclass @REQUIRED YES - Indicates that this variable must be set by the developer. + 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. + 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. + Multiline freetext + Long description for the eclass variable @@ -459,11 +459,11 @@ documentation are: NO - Name of the function to which the documentation block applies. + 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. + convention etc. Must appear as the first tag in the comment block @@ -474,7 +474,7 @@ documentation are: NO - List of required and optional arguments to the function. + List of required and optional arguments to the function List of arguments that the eclass function accepts, specified in @@ -490,7 +490,7 @@ documentation are: * - Return value of the function. + Return value of the function

Description for the value returned by the function.

@@ -505,7 +505,7 @@ documentation are: YES - Multiline freetext. + Multiline freetext List of contacts for the eclass function. One line per @@ -518,7 +518,7 @@ documentation are: Indicates whether the function returns a path with ${EPREFIX} prepended - to it. + to it @@ -527,14 +527,14 @@ documentation are: Indicates that the function is internal to the eclass and should - not be called from outside. + 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. + Optionally, the name of a replacement function + Declares that this function should no longer be used in ebuilds @@ -544,7 +544,7 @@ documentation are: * - Multiline freetext. + Multiline freetext

Long description for the eclass function.

@@ -576,7 +576,7 @@ using the following tags: @VARIABLE: NO - Name of the function-specific variable to which the documentation applies. + Name of the function-specific variable to which the documentation applies This tag applies to variables consumed by specific functions of @@ -591,7 +591,7 @@ using the following tags: 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. + mechanism @@ -600,38 +600,38 @@ using the following tags: Indicates that this variable is unset by default if not set by the - developer. + developer @INCLUDES_EPREFIX YES - Indicates that the variable is a path which has ${EPREFIX} prepended. + Indicates that the variable is a path which has ${EPREFIX} prepended @INTERNAL YES - Indicates that the variable is internal to the eclass function. + Indicates that the variable is internal to the eclass function @REQUIRED YES - Indicates that this variable must be set by the developer. + 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. + 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. + Multiline freetext + Long description for the function variable