diff options
author | Marco Residori <marco_residori@mentor.com> | 2017-01-26 01:28:43 -0800 |
---|---|---|
committer | Marco Residori <marco_residori@mentor.com> | 2017-01-26 01:28:43 -0800 |
commit | a538ee2b2f024787ad188e840a9935dba37fe4c8 (patch) | |
tree | 73bfc90851fabd05909fa8bfd67017a7446385bf | |
parent | 4652f723f1d000afbc137b846f4da83d90ba88f4 (diff) | |
download | positioning-a538ee2b2f024787ad188e840a9935dba37fe4c8.tar.gz |
Update README files. The Franca fidl files are now the official interfaces of the EnhancedPositionService component
-rw-r--r-- | ReleaseNotes | 12 | ||||
-rw-r--r-- | enhanced-position-service/README | 12 | ||||
-rw-r--r-- | enhanced-position-service/dbus/README | 6 | ||||
-rw-r--r-- | enhanced-position-service/dbus/api/README (renamed from enhanced-position-service/franca/api/README) | 8 |
4 files changed, 26 insertions, 12 deletions
diff --git a/ReleaseNotes b/ReleaseNotes index 9e9e9be..bd9ba88 100644 --- a/ReleaseNotes +++ b/ReleaseNotes @@ -18,18 +18,22 @@ Prefixes have been used to distinguish tags referring to different components: The versions used in the tags must always match the versions of the GENIVI components specifications contained in the folder 'doc'. Example: -The tag ENPOS-4.0.0 identifies a stable version of the EnhancedPositionService that contains the document -GENIVI_EnhancedPositionService_ComponentSpecification.pdf version 4.0.0. +The tag ENPOS-5.0.0 identifies a stable version of the EnhancedPositionService that contains the document +GENIVI_EnhancedPositionService_ComponentSpecification.pdf version 5.0.0. Versions ------------ +ENPOS-5.0.0 Stable release of EnhancedPositionService v5.0.0 +SNS-5.0.0 Stable release of SensorsService v5.0.0 +GNSS-5.0.0 Stable release of GNSSService v5.0.0 + ENPOS-4.0.0 Stable release of EnhancedPositionService v4.0.0 SNS-4.0.0 Stable release of SensorsService v4.0.0 -GNSS-4.0.0 Stable release of GNSSService v4.0.0 rel +GNSS-4.0.0 Stable release of GNSSService v4.0.0 ENPOS-3.0.0 Stable release of EnhancedPositionService v3.0.0 SNS-3.0.1 Stable release of SensorsService v3.0.1 -GNSS-3.0.0 Stable release of GNSSService v3.0.0 rel +GNSS-3.0.0 Stable release of GNSSService v3.0.0 Changes ------------ diff --git a/enhanced-position-service/README b/enhanced-position-service/README index 8a13f37..3c8adb9 100644 --- a/enhanced-position-service/README +++ b/enhanced-position-service/README @@ -1,9 +1,13 @@ +The folder 'franca' contains: +- the interface description in Franca IDL +- a version of the PoC that offers C++ interfaces generated using commonapi +Starting with the version 5.0.0 the Franca fild files define the official +GENIVI interface of the EnhancedPositionService + The folder 'dbus' contains: -- the interface description in DBU-XML (offcial GENIVI APIs) +- the interface description in DBU-XML - a version of the PoC that offers D-Bus interfaces -The folder 'franca' contains: -- the interface description in Franca IDL (draft) -- a version of the PoC that offers C++ interfaces generated using commonapi + diff --git a/enhanced-position-service/dbus/README b/enhanced-position-service/dbus/README new file mode 100644 index 0000000..22a463d --- /dev/null +++ b/enhanced-position-service/dbus/README @@ -0,0 +1,6 @@ +Starting with the version 5.0.0, the Franca fidl files in the folder franca/api define +the official GENIVI interface of the EnhancedPositionService component + +The interface defined in the XML files in the folder dbus/api may diverge +from the offical API defined in the fidl files. +This is a well-known problem that will be solved in future releases. diff --git a/enhanced-position-service/franca/api/README b/enhanced-position-service/dbus/api/README index 28a3053..f1340c5 100644 --- a/enhanced-position-service/franca/api/README +++ b/enhanced-position-service/dbus/api/README @@ -2,8 +2,8 @@ IMPORTANT NOTE --------------------------------------------------------------------------------------------------------------------------------- -Please note that the Franca interfaces described in the current folder (*.fidl) are still a draft. -The conversion of the D-Bus interfaces into Franca interfaces have not been completed yet. +Please note that the interfaces described in the current folder (*.xml) are obsolete +and will be removed in futurre releases. -The official GENIVI interfaces of the EnhancedPositionService are those defined in the D-Bus XML files -contained in the folder 'api' inside of 'dbus' +The official GENIVI interfaces of the EnhancedPositionService are those defined in the fidl files +contained in the folder 'api' inside of 'franca' |