Changes between Version 5 and Version 6 of Obsolete/MovedToTree/PackageManagement/PackagingPolicy

Timestamp:

Jun 5, 2013, 11:08:53 PM (11 years ago)

Author:

bonefish

Comment:

--

Obsolete/MovedToTree/PackageManagement/PackagingPolicy

@@ -45 +45 @@
 
 
-== Settings Files ==
+== Writable and Settings Files and Directories ==
 
-All settings/configuration files -- global or user specific -- that the package includes or the packaged software creates or requires the user to create shall be declared by the package (via GLOBAL_SETTINGS_FILES respectively USER_SETTINGS_FILES in the build recipe) in the following way:
+All global writable files and directories as well as user settings files and directories that the package includes or the packaged software creates or requires the user to create shall be declared by the package (via GLOBAL_WRITABLE_FILES respectively USER_SETTINGS_FILES in the build recipe) in the following way:
  * A user specific settings file shall never be installed on package activation. Usually user specific settings files are completely optional. In the rare case that a software requires a user specific settings, the user will have to create it manually. In either case, if the package includes a template user settings file, that should be declared:
    {{{
@@ -56 +56 @@
    USER_SETTINGS_FILES="settings/foo"
    }}}
- * Since many ported software requires a global settings file, a default settings file can be provided and is automatically installed on package activation. In that case the package must also declare what shall be done with a user-modified settings file when the package is updated. E.g.:
+ * Since many ported software requires a global settings file or other writable files, a default version of such a file can be provided and is automatically installed on package activation. In that case the package must also declare what shall be done with a user-modified file when the package is updated. E.g.:
    {{{
-   GLOBAL_SETTINGS_FILES="settings/foo keep-old"
+   GLOBAL_WRITABLE_FILES="settings/foo keep-old"
    }}}
-   "keep-old" indicates that the software can read old settings files and the user-modified file should be kept. "manual" indicates that the software may not be able to read an older file and the user may have to manually adjust it. "auto-merge" indicates that the file format is simple text and a three-way merge shall be attempted. If a default settings file is not included in the package, the settings file shall still be declared, just without the additional keyword.
+   "keep-old" indicates that the software can read old files and the user-modified file should be kept. "manual" indicates that the software may not be able to read an older file and the user may have to manually adjust it. "auto-merge" indicates that the file format is simple text and a three-way merge shall be attempted. If a default settings file is not included in the package, the settings file shall still be declared, just without the additional keyword.
+In both cases, user settings files and global writable files, the "directory" keyword can be used to indicate that the given path actually refers to a directory.