]> code.ossystems Code Review - openembedded-core.git/commitdiff
documentation: Document PACKAGE_SNAP_LIB_SYMLINKS
authorMike Crowe <mac@mcrowe.com>
Tue, 7 Dec 2021 15:27:36 +0000 (15:27 +0000)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Sun, 12 Dec 2021 11:27:20 +0000 (11:27 +0000)
PACKAGE_SNAP_LIB_SYMLINKS was added[1] originally to OpenEmbedded in
2008 and then to oe-core in 2011[2] but appears to have evaded
documentation throughout that time. Let's add something that at least
gives some clue as to what it does.

Signed-off-by: Mike Crowe <mac@mcrowe.com>
Signed-off-by: Phil Blundell <pb@pbcl.net>
[1] https://git.openembedded.org/openembedded/commit/?id=cf7114179ead8ddff8f66e84d630811920ac9add
[2] https://git.openembedded.org/openembedded-core/commit/?id=600dbb7cb384c2290af38b993a9bea3a4dfc4494

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
meta/conf/documentation.conf

index 45cd01374af4cbd39e8a44a759472a146a6da652..f63f4b223a1fb5a46e8c9023d1126115e3832680 100644 (file)
@@ -315,6 +315,7 @@ PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed p
 PACKAGE_EXTRA_ARCHS[doc] = "Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors."
 PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list."
 PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined."
+PACKAGE_SNAP_LIB_SYMLINKS[doc] = "Rename library files based on their SONAME to avoid an extra layer of indirection through a symlink. Only suitable for a read-only rootfs where libraries are not upgraded in place."
 PACKAGECONFIG[doc] = "This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis."
 PACKAGES[doc] = "The list of packages to be created from the recipe."
 PACKAGES_DYNAMIC[doc] = "A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes."