Changes between Version 17 and Version 18 of Obsolete/MovedToTree/PackageManagement/BuildingPackages

Timestamp:

Jun 5, 2013, 10:58:13 PM (11 years ago)

Author:

bonefish

Comment:

--

Obsolete/MovedToTree/PackageManagement/BuildingPackages

@@ -74 +74 @@
  * `freshens`: A list of entities that are being freshened by this package (i.e. this package will patch one or more files of the package(s) that provide this entity). The list elements must have the `required_entity` format.
  * `replaces`: A list of entities that are being replaced by this package (used if the name of a package changes, or if a package has been split). The list elements must have the `entity_name` format.
- * `global-settings-files`: A list of global settings file infos. The list elements must have the following format:
+ * `global-writable-files`: A list of global writable file infos. The list elements must have the following format:
 {{{
-global_settings_file_info:      ::= path [ "keep-old" | "manual" | "auto-merge" ]
+global_writable_file_info:      ::= path [ "directory" ]  [ "keep-old" | "manual" | "auto-merge" ]
 }}}
-   `path` is the relative path of the settings file, starting with "settings/". If no keyword is given after the path, the settings file is not included in the package. It will be created by the software or by the user. If a keyword is given, the settings file (a default version) is included in the package and it will be extracted on package activation. The keyword specifies what shall happen when the package is updated and a previous default version of the settings file has been modified by the user:
-   - "keep-old": Indicates that the software can read old settings files and the user-modified file should be kept.
+   `path` is the relative path of the writable file or directory, starting with "settings/" or any other writable directory. If the "directory" keyword is given, the path refers to a directory. If no other keyword is given after the path respectively after the "directory" keyword, the file or directory is not included in the package. It will be created by the software or by the user. If a keyword is given, the file or directory (a default version) is included in the package and it will be extracted on package activation. The keyword specifies what shall happen when the package is updated and a previous default version of the file or directory has been modified by the user:
+   - "keep-old": Indicates that the software can read old files and the user-modified file or directory 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.
+   - "auto-merge": Indicates that the file format is simple text and a three-way merge shall be attempted (not applicable for directories).
  * `user-settings-files`: A list of user settings file infos. The list elements must have the following format:
 {{{
-user_settings_file_info:        ::= path [ "template" template_path ]
+user_settings_file_info:        ::= path [ "directory" | "template" template_path ]
 }}}
-   `path` is the relative path of the settings file, starting with "settings/". It is not included in the package. However, if `template_path` is specified, it is a path to a file included in the package that can serve as a template for the settings file. It doesn't implies any automatic action on package activation, though.
+   `path` is the relative path of the settings file or directory, starting with "settings/". It is not included in the package. However, if `template_path` is specified, it is a path to a file included in the package that can serve as a template for the settings file. It doesn't implies any automatic action on package activation, though. If the "directory" keyword is given, the path refers to a settings directory (typical when a program creates multiple settings files).
  * `users`: A list of specifications for Unix users the packaged software requires. The list elements must have the following format:
 {{{