packaging/guidelines
6
2
Fork 11
Code Issues 111 Pull requests 27 Projects Releases Packages Wiki Activity Actions

trivial: make all inline text literal

Browse source 
Signed-off-by: Igor Gnatenko <ignatenkobrain@fedoraproject.org>
This commit is contained in:
Igor Gnatenko 2018-09-21 16:14:57 +02:00
commit 1d0bff1b20
No known key found for this signature in database
GPG key ID: 695714BD1BBC5F4C
66 changed files with 1387 additions and 1369 deletions
Download patch file Download diff file Expand all files Collapse all files

8
guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc
View file

@ -20,13 +20,13 @@ We want to ensure that all packages have sensible defaults for whichever Product
=== Per-Product Default Configuration
* For each Product requiring a unique default configuration, the packager MUST provide a copy of the default configuration file, modified as appropriate for the specific product.
* The product-specific configuration file MUST be named based on the package's normal naming scheme, with the main part of the name being suffixed by a dash followed by the name of the product. For example, if the package normally uses `foo.conf`, then the Server version MUST be named `foo-server.conf`.
* If the configuration will be symlinked in place, the product-specific configuration file MUST be located in an appropriate part of the /etc hierarchy. The divergent config file MUST be specified as `%config(noreplace)` in %files as per the usual /etc packaging guidelines.
* The product-specific configuration file MUST be named based on the package's normal naming scheme, with the main part of the name being suffixed by a dash followed by the name of the product. For example, if the package normally uses `+foo.conf+`, then the Server version MUST be named `+foo-server.conf+`.
* If the configuration will be symlinked in place, the product-specific configuration file MUST be located in an appropriate part of the /etc hierarchy. The divergent config file MUST be specified as `+%config(noreplace)+` in %files as per the usual /etc packaging guidelines.
* If the configuration will be copied in place, the product-specific configuration file MUST be located in an appropriate part of the /usr/share hierarchy. The divergent config file MUST be specified as a normal file in the %files section.
=== Applying Configuration
In order to apply the configuration, the packager MUST implement a mechanism in the `%posttrans` section of the specfile that behaves as follows:
In order to apply the configuration, the packager MUST implement a mechanism in the `+%posttrans+` section of the specfile that behaves as follows:
* It MUST first check whether the final config file already exists. If so, the script MUST make no changes.
@ -37,7 +37,7 @@ if [ ! -e %{_sysconfdir}/foo/foo.conf ]; then
fi
....
* Then it MUST use the value of the Fedora `VARIANT_ID` to symlink or copy one of the divergent config files (or the default) to the final config file location. It will get this value by importing the contents of /etc/os-release as shell values. Known values of this field at the time of this writing are "atomichost", "cloud", "server" and "workstation". For more detail, see http://www.freedesktop.org/software/systemd/man/os-release.html#VARIANT_ID=[the os-release(5) man page].
* Then it MUST use the value of the Fedora `+VARIANT_ID+` to symlink or copy one of the divergent config files (or the default) to the final config file location. It will get this value by importing the contents of /etc/os-release as shell values. Known values of this field at the time of this writing are "atomichost", "cloud", "server" and "workstation". For more detail, see http://www.freedesktop.org/software/systemd/man/os-release.html#VARIANT_ID=[the os-release(5) man page].
....
. /etc/os-release || :