| 1 |
commit: 8efea8b918e6b9f12d8612ed4c9bb498fcdbd33a |
| 2 |
Author: Sam James <sam <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Fri Jun 18 05:03:31 2021 +0000 |
| 4 |
Commit: Sam James <sam <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Sun Aug 1 02:38:39 2021 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=8efea8b9 |
| 7 |
|
| 8 |
ebuild-writing/common-mistakes: reformat 'DESCRIPTION and HOMEPAGE' |
| 9 |
|
| 10 |
Closes: https://github.com/gentoo/devmanual/pull/223 |
| 11 |
Signed-off-by: Sam James <sam <AT> gentoo.org> |
| 12 |
|
| 13 |
ebuild-writing/common-mistakes/text.xml | 9 +++++---- |
| 14 |
1 file changed, 5 insertions(+), 4 deletions(-) |
| 15 |
|
| 16 |
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml |
| 17 |
index cc87d74..e46a36c 100644 |
| 18 |
--- a/ebuild-writing/common-mistakes/text.xml |
| 19 |
+++ b/ebuild-writing/common-mistakes/text.xml |
| 20 |
@@ -413,11 +413,12 @@ SLOT="0" |
| 21 |
<body> |
| 22 |
|
| 23 |
<p> |
| 24 |
+Make sure the <c>DESCRIPTION</c> is not overly long. Good descriptions will |
| 25 |
+describe the main function of the package in a sentence. |
| 26 |
+ |
| 27 |
Please check if the <c>HOMEPAGE</c> variable is right and leads users to the |
| 28 |
-right page if they want to find out more about the package. And make sure |
| 29 |
-the <c>DESCRIPTION</c> is not overly long. Good descriptions will describe |
| 30 |
-the main function of the package in a sentence. If no homepage for the package |
| 31 |
-is available, set the <c>HOMEPAGE</c> variable to |
| 32 |
+right page if they want to find out more about the package. If no homepage for |
| 33 |
+the package is available, set the <c>HOMEPAGE</c> variable to |
| 34 |
<c>https://wiki.gentoo.org/wiki/No_homepage</c>. Please also strive to test |
| 35 |
HTTPS support for the site used in <c>HOMEPAGE</c>. |
| 36 |
</p> |
Archives