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