PR#801: guidelines: discourage using globs for shared libraries - packaging-committee

packaging-committee

#801 guidelines: discourage using globs for shared libraries

Closed 5 years ago by ignatenkobrain. Opened 5 years ago by decathorpe.

Unknown source master into master

Makefile: revert accidentally committed local change

Fabio Valentini • 5 years ago

7fa84ba

guidelines: fix a typo

Fabio Valentini • 5 years ago

fffc564

guidelines: incorporate comments on PR#801

Fabio Valentini • 5 years ago

fab16d3

guidelines: discourage using globs for shared libraries

Fabio Valentini • 5 years ago

3eec568

guidelines/modules/ROOT/pages/index.adoc

file modified

+17

		`@@ -1,6 +1,7 @@`
		`:abi-comparison-tool: https://fedoraproject.org/wiki/How_to_check_for_ABI_changes_in_a_package[ABI comparison tool]`
		`:packaging-committee: https://pagure.io/packaging-committee[Fedora Packaging Committee]`
		`:scl-guidelines: https://fedoraproject.org/wiki/User:Toshio/SCL_Guidelines_(draft)[Software Collections]`
		`+ :updates-policy: https://fedoraproject.org/wiki/Updates_Policy[Updates Policy]`

		`= Fedora Packaging Guidelines`

		`@@ -598,6 +599,22 @@`

		`Whenever possible (and feasible), Fedora packages containing libraries SHOULD build them as shared libraries. See xref:Scriptlets.adoc#shared-libraries[Scriptlets#Shared Libraries] for information about whether scriptlets are required.`

		`+ === Listing shared library files`
		`+`
		+ Shared libraries installed directly into `+%{_libdir}+` SHOULD NOT be listed
		+ in the `%files` section of the spec by using a glob in a way
		+ that conceals important parts of the file name (e.g. `libfoo.so*`),
		+ since changes to the `SONAME` also result in a changed file name in most cases.
		`+`
		+ Otherwise, when the library bumps its `SONAME` as part of an update,
		`+ this change might remain unnoticed and cause problems like broken dependencies`
		`+ (see the relevant {updates-policy} section for further information).`
		`+`
		`+ However, if the use of globs is deemed useful by the packager - for example,`
		+ if the `Y` and `Z` parts of a library named `libfoo.so.X.Y.Z` change frequently,
		+ using something like `libfoo.so.X*` is recommended instead,
		`+ since dependent packages usually don't have to be rebuilt for changes of this kind.`
		`+`
		`=== Downstream .so name versioning`

		`In cases where upstream ships unversioned .so library (so this is not needed for plugins, drivers, etc.), the packager MUST try to convince upstream to start versioning it.`

decathorpe commented 5 years ago

Add a small paragraph to the Shared Libraries section, discouraging the usage of globs where they might cause unintended problems.

decathorpe commented 5 years ago

This is the first time I've used asciidoc, so feel free to fix any markup issues. Rendered locally it looked fine, though.

ignatenkobrain commented on line 18 of guidelines/modules/ROOT/pages/index.adoc 5 years ago

I would probably use SONAME (in upper case)

ignatenkobrain commented on line 18 of guidelines/modules/ROOT/pages/index.adoc 5 years ago

also unless people do weird things, it will be reflected in file name (because we run brp-ldconfig which ensures that the files which match soname are created).

ignatenkobrain commented 5 years ago

Apart from few comments inline, lgtm ;)

@jwakely r?

1 new commit added