From 171846c4f2454202b5bc89682a67056c6fb51bcc Mon Sep 17 00:00:00 2001 From: Petr Menšík Date: May 03 2022 15:59:16 +0000 Subject: Update missing header1 in some sections --- diff --git a/guidelines/modules/ROOT/pages/CronFiles.adoc b/guidelines/modules/ROOT/pages/CronFiles.adoc index efe73bf..b6a5609 100644 --- a/guidelines/modules/ROOT/pages/CronFiles.adoc +++ b/guidelines/modules/ROOT/pages/CronFiles.adoc @@ -1,4 +1,4 @@ -== Fedora Cron Job Files += Fedora Cron Job Files This document describes the guidelines for packaging cron job files in Fedora. diff --git a/guidelines/modules/ROOT/pages/CryptoPolicies.adoc b/guidelines/modules/ROOT/pages/CryptoPolicies.adoc index b12ab8c..cf3a089 100644 --- a/guidelines/modules/ROOT/pages/CryptoPolicies.adoc +++ b/guidelines/modules/ROOT/pages/CryptoPolicies.adoc @@ -1,3 +1,5 @@ += Crypto Policies + == Enforcing system crypto policies In Fedora there are policies for the usage of cryptographic protocols such as TLS that are enforced system-wide. Each application being added in Fedora must be checked to comply with the policies. Currently the policies are restricted to major libraries such as GnuTLS, OpenSSL, NSS, libkrb5, languages such as Java and major applications like OpenSSH and bind. The rpmlint tool will warn when it detects that some action has to be taken; that detection is based on heuristics and limited to C programs, so manual inspection is recommended. Note however, that there are applications which intentionally set weaker, or custom settings on a purpose (e.g., postfix); those need not adhere to the policy. When in doubt, discuss with the https://lists.fedoraproject.org/mailman/listinfo/security[Fedora security team]. diff --git a/guidelines/modules/ROOT/pages/EnvironmentModules.adoc b/guidelines/modules/ROOT/pages/EnvironmentModules.adoc index b87d1bd..c348263 100644 --- a/guidelines/modules/ROOT/pages/EnvironmentModules.adoc +++ b/guidelines/modules/ROOT/pages/EnvironmentModules.adoc @@ -1,3 +1,5 @@ += Environment Modules + == Introduction When one has multiple programs serving the same purpose (for instance SMTP servers such as sendmail, exim and postfix; or print servers such as lprng and cups), it is usual to wrap these using alternatives. Alternatives provides a clean way to have many types of software serving the same purpose installed at the same time and have the commands such as `+mail+` and `+lpr+` point to the wanted versions. diff --git a/guidelines/modules/ROOT/pages/Langpacks.adoc b/guidelines/modules/ROOT/pages/Langpacks.adoc index 20e17ec..f5e3840 100644 --- a/guidelines/modules/ROOT/pages/Langpacks.adoc +++ b/guidelines/modules/ROOT/pages/Langpacks.adoc @@ -1,3 +1,5 @@ += Language packages + The idea behind "langpacks" is to separate translations or language specific content into subpackages in the case that the size of the files is huge or the package is part of a core image that should be minimal. Subpackages that exist solely to contain additional language translations or content must be named in the form -langpack-, where is the name of the package that the langpacks belong to and is a valid language code from _/usr/share/xml/iso-codes/iso_639_3.xml_ or from _/usr/share/i18n/locales/_. Specifically, the langcode value used in the package name must agree with the langcode identifier used in the directory path by upstream for the translation or language files. diff --git a/guidelines/modules/ROOT/pages/LibreOfficeExtensions.adoc b/guidelines/modules/ROOT/pages/LibreOfficeExtensions.adoc index 418a35c..8fb57fc 100644 --- a/guidelines/modules/ROOT/pages/LibreOfficeExtensions.adoc +++ b/guidelines/modules/ROOT/pages/LibreOfficeExtensions.adoc @@ -1,4 +1,4 @@ -== LibreOffice extension rpm guidelines += LibreOffice extension rpm guidelines 1. Extensions *Must* be installed unpacked under %\{_libdir}/libreoffice/share/extensions. These are termed bundled extensions. Extensions should not be installed as shared extensions i.e. via unopkg --shared + 2. An extension should normally just be able to Require: an appropriate LibreOffice component e.g. libreoffice-core, without a specific n-v-r as extensions use the stable UNO ABI which rarely changes, and then only to add extra APIs. So unless you require a specific feature of a LibreOffice release there is no need to require a specific n-v-r and force a rebuild on every n-v-r of libreoffice. + diff --git a/guidelines/modules/ROOT/pages/MPI.adoc b/guidelines/modules/ROOT/pages/MPI.adoc index 8f49fc6..9a488fd 100644 --- a/guidelines/modules/ROOT/pages/MPI.adoc +++ b/guidelines/modules/ROOT/pages/MPI.adoc @@ -1,3 +1,5 @@ += Message Passing Interface + == Introduction Message Passing Interface (MPI) is an API for parallelization of programs across multiple nodes and has been around since 1994 https://en.wikipedia.org/wiki/Message_Passing_Interface[1]. MPI can also be used for parallelization on SMP machines and is considered very efficient in it too (close to 100% scaling on parallelizable code as compared to ~80% commonly obtained with threads due to unoptimal memory allocation on NUMA machines). Before MPI, about every manufacturer of supercomputers had their own programming language for writing programs; MPI made porting software easy. diff --git a/guidelines/modules/ROOT/pages/RPM_Source_Dir.adoc b/guidelines/modules/ROOT/pages/RPM_Source_Dir.adoc index 997ccbc..07533e3 100644 --- a/guidelines/modules/ROOT/pages/RPM_Source_Dir.adoc +++ b/guidelines/modules/ROOT/pages/RPM_Source_Dir.adoc @@ -1,4 +1,4 @@ -== $RPM_SOURCE_DIR or %\{_sourcedir} += $RPM_SOURCE_DIR or %\{_sourcedir} Packages which use files itemized as Source# files, must refer to those files by their Source# macro name, and must not use $RPM_SOURCE_DIR or %\{sourcedir} to refer to those files. diff --git a/guidelines/modules/ROOT/pages/Web_Assets.adoc b/guidelines/modules/ROOT/pages/Web_Assets.adoc index 2f3a057..232162e 100644 --- a/guidelines/modules/ROOT/pages/Web_Assets.adoc +++ b/guidelines/modules/ROOT/pages/Web_Assets.adoc @@ -1,4 +1,4 @@ -= Web Assets += Web Assets Packaging Guidelines == Scope diff --git a/guidelines/modules/ROOT/pages/WordPress_plugin_packaging_guidelines.adoc b/guidelines/modules/ROOT/pages/WordPress_plugin_packaging_guidelines.adoc index a9adf0d..5c3ab45 100644 --- a/guidelines/modules/ROOT/pages/WordPress_plugin_packaging_guidelines.adoc +++ b/guidelines/modules/ROOT/pages/WordPress_plugin_packaging_guidelines.adoc @@ -1,3 +1,4 @@ += WordPress plugins Packaging Guidelines https://wordpress.org/plugins/[WordPress plugins] are packaged for Fedora so that the plugin can be used for both and without requiring both. == Requirements for packaging