From 68f5f18a83dfc2852194d62f4ceccfb49bb6dcba Mon Sep 17 00:00:00 2001 From: Brian (bex) Exelbierd Date: Jul 12 2019 18:36:20 +0000 Subject: clarify summary and description section --- diff --git a/guidelines/modules/ROOT/pages/index.adoc b/guidelines/modules/ROOT/pages/index.adoc index 428fd9b..5d41639 100644 --- a/guidelines/modules/ROOT/pages/index.adoc +++ b/guidelines/modules/ROOT/pages/index.adoc @@ -437,17 +437,29 @@ This would prevent yum-builddep or similar tools that use the SRPM's requirement === BuildRequires based on pkg-config -Fedora packages which use `+pkg-config+` to build against a library (e.g. 'foo') on which they depend, *SHOULD* express their build dependency correctly as `+pkgconfig(foo)+`. For more information, see xref:PkgConfigBuildRequires.adoc[Packaging:PkgConfigBuildRequires]. +Fedora packages which use `+pkg-config+` to build against a library (e.g. 'foo') on which they depend, *SHOULD* express their build dependency correctly as `+pkgconfig(foo)+`. +For more information, see xref:PkgConfigBuildRequires.adoc[Packaging:PkgConfigBuildRequires]. == Conditional build-time dependencies -If the spec file contains conditional dependencies selected based on presence of optional `+--with(out) foo+` arguments to `+rpmbuild+`, build the source RPM to be submitted with the default options, i.e., so that none of these arguments are present in the `+rpmbuild+` command line. The reason is that those requirements get "serialized" into the resulting source RPM, i.e., the conditionals no longer apply. +If the spec file contains conditional dependencies selected based on presence of optional `+--with(out) foo+` arguments to `+rpmbuild+`, build the source RPM to be submitted with the default options, i.e., so that none of these arguments are present in the `+rpmbuild+` command line. +The reason is that those requirements get "serialized" into the resulting source RPM, i.e., the conditionals no longer apply. == Summary and description -The summary should be a short and concise description of the package. The description expands upon this. Do not include installation instructions in the description; it is not a manual. If the package requires some manual configuration or there are other important instructions to the user, refer the user to the documentation in the package. Add a _README.Fedora_, or similar, if you feel this is necessary. Also, please make sure that there are no lines in the description longer than 80 characters. +The summary should be a short and concise description of the package. The description should expand upon this. -Please put personal preferences aside and use American English spelling in the summary and description. Packages can contain additional translated summary/description for supported Non-English languages, if available. +=== Dos and Don'ts + +* The summary should be 80 characters/columns or less. + If you are using something other than ASCII look at a utf length function or something similar to calculate the column count. +* Make sure that there are no lines in the description longer than 80 characters/columns. + If you are using something other than ASCII look at a utf length function or something similar to calculate the column count. +* Do not include installation instructions in the description; it is not a manual + If the package requires some manual configuration or there are other important instructions to the user, refer the user to the documentation in the package + Add a _README.Fedora_, or similar, if you feel this is necessary. +* For consistency, we use the American English spelling and grammar rules in the summary and description. + Packages can contain additional translated summary/description for supported Non-English languages, if available. === Trademarks in Summary or Description