Added use of default data for files; added test data that can be used by PAS installation process; started to implement persclient_tools; updates after interface review

4 files changed, 30 insertions, 17 deletions

diff --git a/include/persistence_client_library.h b/include/persistence_client_library.h
index 29bbcb1..1e6b085 100644
--- a/include/persistence_client_library.h
+++ b/include/persistence_client_library.h
@@ -20,11 +20,11 @@
  * \par change history
  * Date     Author          Version
  * 25/06/13 Ingo Hürner     1.0.0 - Rework of Init functions
- * 04/11/13 Ingo Hürner     2.0.0 - Added define for shutdown type none
+ * 04/11/13 Ingo Hürner     1.3.0 - Added define for shutdown type none
  *
  */
 /** \ingroup GEN_PERS */
-/** \defgroup PERS_CLIENT Client: initialisation access
+/** \defgroup PERS_CLIENT Client: initialization access
  *  \{
  */
 /** \defgroup PERS_CLIENT_INTERFACE API document
@@ -44,21 +44,29 @@ extern "C" {
 /** \} */
 
 
-/** \defgroup PCL_OVERALL functions for Library Initialisation
- * The following functions have to be called to allow intialisation of the internal interfaces.
+/** \defgroup SHUTDOWN_TYPE notifications type definitions
+ * according to Node State Manager Component
  * \{
  */
 
-#define PCL_SHUTDOWN             1		/// trigger shutdown
-#define PCL_SHUTDOWN_CANEL       0		// cancel shutdown
-
 #define PCL_SHUTDOWN_TYPE_FAST   2     /// Client registered for fast lifecycle shutdown
 #define PCL_SHUTDOWN_TYPE_NORMAL 1     /// Client registered for normal lifecycle shutdown
 #define PCL_SHUTDOWN_TYPE_NONE   0     /// Client does not register to lifecycle shutdown
+/** \} */
+
+
+/** \defgroup PCL_OVERALL functions for Library initialization
+ *  The following functions have to be called for library initialization
+ * \{
+ */
+
+
+#define PCL_SHUTDOWN             1		/// trigger shutdown
+#define PCL_SHUTDOWN_CANEL       0		/// cancel shutdown
 
 
 /**
- * @brief initalize client library.
+ * @brief initialize client library.
  *        This function will be called by the process using the PCL during startup phase.
  *
  * @attention This function is currently  N O T  part of the GENIVI compliance specification
@@ -96,6 +104,11 @@ int pclDeinitLibrary(void);
  * @attention This function is currently  N O T  part of the GENIVI compliance specification
  * @attention In order to prevent misuse of this function the cancel shutdown request
  *            can only be called 3 times per lifecycle.
+ *            If this function has been called by an application more then 3 times the application
+ *            will not be able to store it's data anymore during the current lifecycle.
+ *            The application isn't fully operable in this lifecycle anymore.
+ *            In the next lifecycle the application can store data again until the limit above
+ *            has been reached.
  *
  * @parm PCL_SHUTDOWN for write back data when shutdown is requested,
  *       and PCL_SHUTDOWN_CANEL when shutdown cancel request has been received.
diff --git a/include/persistence_client_library_error_def.h b/include/persistence_client_library_error_def.h
index d8de109..e88efa5 100644
--- a/include/persistence_client_library_error_def.h
+++ b/include/persistence_client_library_error_def.h
@@ -16,8 +16,13 @@
  * @ingroup        Persistence client library
  * @author         Ingo Huerner
  * @brief          Error definition header
- * @see
+ *
+ * @par change history
+ * Date     Author           Version
+ * 29/04/14 Ingo Huerner     1.0.0 - Added cancel shutdown errors
+ *
  */
+
 /** \ingroup GEN_PERS */
 /** \defgroup PERS_GEN_ERROR Client Library: Generic errors
  *  \{
@@ -108,9 +113,9 @@ extern "C" {
 /// write to requested resource failed, read only resource
 #define EPERS_RESOURCE_READ_ONLY (-39)
 /// max numbers of cancel shutdown exceeded
-#define EPERS_SHTDWN_MAX_CANCEL  (-40)
+#define EPERS_SHUTDOWN_MAX_CANCEL (-40)
 /// not permitted to use this function
-#define EPERS_SHTDWN_NO_PERMIT  (-42)
+#define EPERS_SHUTDOWN_NO_PERMIT  (-42)
 
 #ifdef __cplusplus
 }
diff --git a/include/persistence_client_library_file.h b/include/persistence_client_library_file.h
index 2cdbccd..e116dd6 100644
--- a/include/persistence_client_library_file.h
+++ b/include/persistence_client_library_file.h
@@ -216,7 +216,7 @@ int pclFileCreatePath(unsigned int ldbid, const char* resource_id, unsigned int
  * ::EPERS_LOCKFS or ::EPERS_COMMON
  * If ::EPERS_COMMON will be returned errno will be set.
  */
-int pclFileReleasePath(int pathPandle);
+int pclFileReleasePath(int pathHandle);
 
 /** \} */ 
 
diff --git a/include/persistence_client_library_key.h b/include/persistence_client_library_key.h
index 52e4aa6..46d0e8c 100644
--- a/include/persistence_client_library_key.h
+++ b/include/persistence_client_library_key.h
@@ -71,15 +71,10 @@ typedef struct _pclNotification_s
    unsigned int seat_no;                     /// seat id
 } pclNotification_s;
 
-/** \defgroup SHUTDOWN_TYPE shutdown notification type definitions
- *  according to Node State Manager component
- * \{
- */
 
 
 /** \} */
 
-/** \} */
 
 /** definition of the change callback
  *