From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: eclass-writing/
Date: Sat, 4 Sep 2021 10:36:55 +0000 (UTC) [thread overview]
Message-ID: <1630751712.c2ddff702a72b8240915e8fb583a753670a1a553.ulm@gentoo> (raw)
commit: c2ddff702a72b8240915e8fb583a753670a1a553
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Sep 1 18:12:50 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> 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 <ulm <AT> 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:
<th>description</th>
</tr>
<tr>
- <ti>
- <c>@ECLASS:</c>
- </ti>
- <ti>
- NO
- </ti>
- <ti>
- Name of the eclass being documented
- </ti>
+ <ti><c>@ECLASS:</c></ti>
+ <ti>NO</ti>
+ <ti>Name of the eclass being documented</ti>
<ti>
Documents various information about the eclass. Must appear as the
first tag in the comment block.
</ti>
</tr>
<tr>
- <ti>
- <c>@MAINTAINER:</c>
- </ti>
- <ti>
- NO
- </ti>
- <ti>
- One or more name and email pairs
- </ti>
+ <ti><c>@MAINTAINER:</c></ti>
+ <ti>NO</ti>
+ <ti>One or more name and email pairs</ti>
<ti>
List of maintainers for the eclass to be contacted. One line per
maintainer. Must start on a newline after the tag.
</ti>
</tr>
<tr>
- <ti>
- <c>@AUTHOR:</c>
- </ti>
- <ti>
- YES
- </ti>
- <ti>
- One or more name and email pairs
- </ti>
+ <ti><c>@AUTHOR:</c></ti>
+ <ti>YES</ti>
+ <ti>One or more name and email pairs</ti>
<ti>
List of authors for the eclass. One line per author. Must start on
a newline after the tag.
</ti>
</tr>
<tr>
- <ti>
- <c>@BUGREPORTS:</c>
- </ti>
- <ti>
- YES
- </ti>
- <ti>
- Multiline freetext
- </ti>
- <ti>
- Describes how bugs related to this eclass should be reported
- </ti>
+ <ti><c>@BUGREPORTS:</c></ti>
+ <ti>YES</ti>
+ <ti>Multiline freetext</ti>
+ <ti>Describes how bugs related to this eclass should be reported</ti>
</tr>
<tr>
- <ti>
- <c>@VCSURL:</c>
- </ti>
- <ti>
- YES
- </ti>
- <ti>
- A URI string
- </ti>
- <ti>
- Points to the URL of the VCS that contains the eclass source
- </ti>
+ <ti><c>@VCSURL:</c></ti>
+ <ti>YES</ti>
+ <ti>A URI string</ti>
+ <ti>Points to the URL of the VCS that contains the eclass source</ti>
</tr>
<tr>
- <ti>
- <c>@BLURB:</c>
- </ti>
- <ti>
- NO
- </ti>
- <ti>
- Single line freetext
- </ti>
+ <ti><c>@BLURB:</c></ti>
+ <ti>NO</ti>
+ <ti>Single line freetext</ti>
<ti>
Contains a short description for the eclass. Must be on the same
line with the tag.
</ti>
</tr>
<tr>
- <ti>
- <c>@DESCRIPTION:</c>
- </ti>
- <ti>
- YES
- </ti>
- <ti>
- Multiline freetext
- </ti>
- <ti>
- Long description for the eclass
- </ti>
+ <ti><c>@DESCRIPTION:</c></ti>
+ <ti>YES</ti>
+ <ti>Multiline freetext</ti>
+ <ti>Long description for the eclass</ti>
</tr>
<tr>
- <ti>
- <c>@EXAMPLE:</c>
- </ti>
- <ti>
- YES
- </ti>
- <ti>
- Multiline freetext
- </ti>
- <ti>
- Examples that illustrate various uses of this eclass
- </ti>
+ <ti><c>@EXAMPLE:</c></ti>
+ <ti>YES</ti>
+ <ti>Multiline freetext</ti>
+ <ti>Examples that illustrate various uses of this eclass</ti>
</tr>
</table>
@@ -338,15 +282,9 @@ variables are as follows:
<th>description</th>
</tr>
<tr>
- <ti nowrap="nowrap">
- <c>@ECLASS-VARIABLE:</c>
- </ti>
- <ti>
- NO
- </ti>
- <ti>
- Name of the eclass variable to which the documentation applies
- </ti>
+ <ti nowrap="nowrap"><c>@ECLASS-VARIABLE:</c></ti>
+ <ti>NO</ti>
+ <ti>Name of the eclass variable to which the documentation applies</ti>
<ti>
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:
<th>description</th>
</tr>
<tr>
- <ti>
- <c>@FUNCTION:</c>
- </ti>
- <ti>
- NO
- </ti>
- <ti>
- Name of the function to which the documentation block applies
- </ti>
+ <ti><c>@FUNCTION:</c></ti>
+ <ti>NO</ti>
+ <ti>Name of the function to which the documentation block applies</ti>
<ti>
Documents information about an eclass function such as its calling
convention etc. Must appear as the first tag in the comment block
</ti>
</tr>
<tr>
- <ti>
- <c>@USAGE:</c>
- </ti>
- <ti>
- NO
- </ti>
- <ti>
- List of required and optional arguments to the function
- </ti>
+ <ti><c>@USAGE:</c></ti>
+ <ti>NO</ti>
+ <ti>List of required and optional arguments to the function</ti>
<ti>
List of arguments that the eclass function accepts, specified in
the following syntax: <c><</c>Required arguments<c>></c>
@@ -483,30 +409,18 @@ documentation are:
</ti>
</tr>
<tr>
- <ti>
- <c>@RETURN:</c>
- </ti>
- <ti>
- <b>*</b>
- </ti>
- <ti>
- Return value of the function
- </ti>
+ <ti><c>@RETURN:</c></ti>
+ <ti><b>*</b></ti>
+ <ti>Return value of the function</ti>
<ti>
<p>Description for the value returned by the function.</p>
<p><b>*</b>: Not optional for functions that return a value.</p>
</ti>
</tr>
<tr>
- <ti>
- <c>@MAINTAINER:</c>
- </ti>
- <ti>
- YES
- </ti>
- <ti>
- Multiline freetext
- </ti>
+ <ti><c>@MAINTAINER:</c></ti>
+ <ti>YES</ti>
+ <ti>Multiline freetext</ti>
<ti>
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:
<ti>Declares that this function should no longer be used in ebuilds</ti>
</tr>
<tr>
- <ti>
- <c>@DESCRIPTION:</c>
- </ti>
- <ti>
- <b>*</b>
- </ti>
- <ti>
- Multiline freetext
- </ti>
+ <ti><c>@DESCRIPTION:</c></ti>
+ <ti><b>*</b></ti>
+ <ti>Multiline freetext</ti>
<ti>
<p>Long description for the eclass function.</p>
<p><b>*:</b> Not optional if <c>RETURN:</c> is absent.</p>
next reply other threads:[~2021-09-04 10:36 UTC|newest]
Thread overview: 48+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-04 10:36 Ulrich Müller [this message]
-- strict thread matches above, loose matches on Subject: below --
2025-01-06 21:37 [gentoo-commits] proj/devmanual:master commit in: eclass-writing/ Ulrich Müller
2024-04-29 6:31 Ulrich Müller
2024-04-29 6:31 Ulrich Müller
2024-04-29 6:31 Ulrich Müller
2024-04-29 6:31 Ulrich Müller
2024-01-19 21:06 Ulrich Müller
2023-08-26 5:30 Ulrich Müller
2023-05-27 18:49 Ulrich Müller
2022-04-30 17:01 Ulrich Müller
2022-04-28 8:12 Ulrich Müller
2022-04-24 12:52 Ulrich Müller
2022-03-26 16:16 Ulrich Müller
2022-03-23 14:10 Ulrich Müller
2022-03-20 13:48 Ulrich Müller
2022-03-18 18:10 Sam James
2022-03-18 18:10 Sam James
2022-03-16 14:47 Sam James
2022-03-16 14:47 Sam James
2021-12-09 5:01 Sam James
2021-10-13 13:44 Ulrich Müller
2021-09-04 10:38 Ulrich Müller
2021-09-04 10:36 Ulrich Müller
2021-09-04 10:33 Ulrich Müller
2021-09-04 10:33 Ulrich Müller
2021-04-07 17:35 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2021-03-30 6:55 Ulrich Müller
2020-12-29 22:08 Göktürk Yüksek
2020-09-18 7:01 Ulrich Müller
2019-09-20 22:52 Göktürk Yüksek
2019-08-30 15:51 Göktürk Yüksek
2019-08-30 15:51 Göktürk Yüksek
2016-10-31 1:21 Göktürk Yüksek
2016-10-31 1:21 Göktürk Yüksek
2016-10-31 1:21 Göktürk Yüksek
2016-10-31 1:21 Göktürk Yüksek
2016-10-31 1:21 Göktürk Yüksek
2011-12-13 20:17 Petteri Räty
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1630751712.c2ddff702a72b8240915e8fb583a753670a1a553.ulm@gentoo \
--to=ulm@gentoo.org \
--cc=gentoo-commits@lists.gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox