You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by kw...@apache.org on 2019/03/18 15:08:54 UTC

[sling-site] branch feature/improve-osgi-installer-config-documentation updated: further clarifications on encoding of .config files

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch feature/improve-osgi-installer-config-documentation
in repository https://gitbox.apache.org/repos/asf/sling-site.git


The following commit(s) were added to refs/heads/feature/improve-osgi-installer-config-documentation by this push:
     new 149ee8e  further clarifications on encoding of .config files
149ee8e is described below

commit 149ee8ee13962e6daf8c481a3299ad80aef3ff55
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Mon Mar 18 16:08:32 2019 +0100

    further clarifications on encoding of .config files
---
 .../documentation/bundles/configuration-installer-factory.md       | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/main/jbake/content/documentation/bundles/configuration-installer-factory.md b/src/main/jbake/content/documentation/bundles/configuration-installer-factory.md
index 5ba6c4b..c847692 100644
--- a/src/main/jbake/content/documentation/bundles/configuration-installer-factory.md
+++ b/src/main/jbake/content/documentation/bundles/configuration-installer-factory.md
@@ -54,9 +54,9 @@ In addition the XML format defined by [java.util.Property](https://docs.oracle.c
 
 ### Configuration Files (.config)
 
-Configuration files ending in `.config` use the format of the [Apache Felix ConfigAdmin implementation](http://svn.apache.org/viewvc/felix/releases/org.apache.felix.configadmin-1.8.12/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java?view=markup) (in version 1.8.12). It allows to specify the type and cardinality of a configuration property and is not limited to string values.
+Configuration files ending in `.config` use the format of the [Apache Felix ConfigAdmin implementation](http://svn.apache.org/viewvc/felix/releases/org.apache.felix.configadmin-1.8.12/src/main/java/org/apache/felix/cm/file/ConfigurationHandler.java?view=markup) (in version 1.8.12). This format allows to specify the type and cardinality of a configuration property and is not limited to string values. It must be stored in UTF-8 encoding.
 
-The first line of such a file might start with a comment line (a line starting with a #). Comments within the file are not allowed.
+The first line of such a file might start with a comment line (a line starting with a `#`). Comments within the file are not allowed.
 
 The format is:
 
@@ -109,6 +109,7 @@ A number of such .config files exist in the Sling codebase and can be used as ex
 
 * No support for collections containing different types
 * No support for nested multivalues (arrays or Collections)
+* No user-friendly (readable) values for floating points ([SLING-7757](https://issues.apache.org/jira/browse/SLING-7757))
 
 ### Configuration Files (.cfg.json)
 
@@ -118,7 +119,7 @@ The exact JSON format is described in the [OSGi R7 Service Configurator Spec](ht
 
 The only differences to the spec are outlined below
 
-* :configurator:resource-version may be used, but only version 1 is supported
+* `:configurator:resource-version` may be used, but only version 1 is supported
 * other keys starting with `:configurator:` should not be used (in general they are validated but not further evaluated)
   * The PID is given via the file name (the part preceeding the `.cfg.json`) instead of `:configurator:symbolic-name`
   * There is no version support i.e. `:configurator:version` should not be used either