diff mbox series

hawkBit: Fix spelling of hawkBit

Message ID 20200918151508.44217-1-christian.storm@siemens.com
State Accepted
Headers show
Series hawkBit: Fix spelling of hawkBit | expand

Commit Message

Storm, Christian Sept. 18, 2020, 3:15 p.m. UTC
Consolidate hawkBit spelling to its official notation 'hawkBit'.

Signed-off-by: Christian Storm <christian.storm@siemens.com>
---
 doc/source/conf.py           |  2 +-
 doc/source/hawkbit-setup.rst | 16 ++++++++--------
 doc/source/roadmap.rst       |  8 ++++----
 doc/source/swupdate-ipc.rst  |  2 +-
 suricatta/server_hawkbit.c   | 26 +++++++++++++-------------
 5 files changed, 27 insertions(+), 27 deletions(-)

Comments

Stefano Babic Sept. 21, 2020, 4:48 p.m. UTC | #1
On 18.09.20 17:15, Christian Storm wrote:
> Consolidate hawkBit spelling to its official notation 'hawkBit'.
> 
> Signed-off-by: Christian Storm <christian.storm@siemens.com>
> ---
>  doc/source/conf.py           |  2 +-
>  doc/source/hawkbit-setup.rst | 16 ++++++++--------
>  doc/source/roadmap.rst       |  8 ++++----
>  doc/source/swupdate-ipc.rst  |  2 +-
>  suricatta/server_hawkbit.c   | 26 +++++++++++++-------------
>  5 files changed, 27 insertions(+), 27 deletions(-)
> 
> diff --git a/doc/source/conf.py b/doc/source/conf.py
> index cdcff47..c6c5e2b 100644
> --- a/doc/source/conf.py
> +++ b/doc/source/conf.py
> @@ -236,7 +236,7 @@ man_pages = [
>          ('index', 'swupdate', u'Swupdate Documentation', [u'Stefano Babic'], 1),
>          ('swupdate-sendtohawkbit', 'sendtohawkbit', u'swupdate-sendtohawkbit tool', '', 1),
>          ('swupdate-client', 'client', u'SWUpdate client tool', '', 1),
> -        ('swupdate-hawkbitcfg', 'hawkbitcfg', u'SWUpdate Hawkbit Configuration tool', '', 1),
> +        ('swupdate-hawkbitcfg', 'hawkbitcfg', u'SWUpdate hawkBit Configuration tool', '', 1),
>          ('swupdate-progress', 'progress', u'SWUpdate progress tool', '', 1),
>          ('swupdate-sysrestart', 'sysrestart', u'SWUpdate sysrestart tool', '', 1),
>          ]
> diff --git a/doc/source/hawkbit-setup.rst b/doc/source/hawkbit-setup.rst
> index 416f5b9..c90ea65 100644
> --- a/doc/source/hawkbit-setup.rst
> +++ b/doc/source/hawkbit-setup.rst
> @@ -1,13 +1,13 @@
>  ==========================================================
> -Config for HawkBit under SSL/TLS using private CA / sub CA
> +Config for hawkBit under SSL/TLS using private CA / sub CA
>  ==========================================================
>  
> -A user-contributed recipe based on HawkBit (0.2.0-SNAPSHOT) + swupdate (v2018.03)
> +A user-contributed recipe based on hawkBit (0.2.0-SNAPSHOT) + swupdate (v2018.03)
>  
>  Purpose
>  -------
>  
> -Use HTTPS on a HawkBit server to avoid server spoofing. Anonymous client connections are authorized.
> +Use HTTPS on a hawkBit server to avoid server spoofing. Anonymous client connections are authorized.
>  
>  Recipe
>  ------
> @@ -18,9 +18,9 @@ Recipe
>   * Use a password on the server key you won't be ashamed of.
>   * Also create a single ``.pem`` file for the private CA + sub-CA
>  
> -2. On the HawkBit host:
> +2. On the hawkBit host:
>  
> - * HawkBit uses the Java KeyStore to access credentials, but a JKS is not designed apparently to hold CA certs, which is a problem for private CAs. The workaround is to make it gulp an entire pkcs#12 file.
> + * hawkBit uses the Java KeyStore to access credentials, but a JKS is not designed apparently to hold CA certs, which is a problem for private CAs. The workaround is to make it gulp an entire pkcs#12 file.
>   * It looks like a JKS like this cannot have a password different from the one protecting the ``.p12``. Keytool also seems to have a little tendency to destruct the ``.jks`` if you change your mind and want to change the password... Basically do everything you need with openssl and use only keytool for generating the ``.jks`` file.
>  
>   The following command imports a ``.p12`` into a "pkcs12 Java keystore", keeping the same password:
> @@ -31,10 +31,10 @@ Recipe
>            -destkeystore hb-pass.jks -deststoretype pkcs12 \
>            -alias 1 -deststorepass <password_of_p12>
>  
> - Then you need to adapt ``application.properties`` of the HawkBit server to make use of the keystore.
> - There are extra requirements to make HawkBit send artifacts via HTTPS.
> + Then you need to adapt ``application.properties`` of the hawkBit server to make use of the keystore.
> + There are extra requirements to make hawkBit send artifacts via HTTPS.
>  
> - This is the relevant part of ``<HawkBit dir>/hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties``::
> + This is the relevant part of ``<hawkBit dir>/hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties``::
>  
>    # HTTPS mode working w/ swupdate
>    # See also https://docs.spring.io/spring-boot/docs/1.4.7.RELEASE/reference/html/howto-embedded-servlet-containers.html#howto-configure-ssl
> diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst
> index b97ee6a..1c73c9b 100644
> --- a/doc/source/roadmap.rst
> +++ b/doc/source/roadmap.rst
> @@ -123,13 +123,13 @@ if an update must be installed instead of installing and performs checks later.
>  If SWUpdate provides a way to inform a checker if an update can be accepted
>  before downloading, a download is only done when it is really necessary.
>  
> -Back-end: Hawkbit Offline support
> +Back-end: hawkBit Offline support
>  ---------------------------------
>  
> -There are several discussions on Hawkbit's ML about how to synchronize
> +There are several discussions on hawkBit's ML about how to synchronize
>  an offline update (done locally or via the internal Web-server) with
> -the Hawkbit's server. Currently, Hawkbit thinks to be the only one
> -deploying software. Hawkbit DDI API should be extended, and afterwards
> +the hawkBit's server. Currently, hawkBit thinks to be the only one
> +deploying software. hawkBit DDI API should be extended, and afterwards
>  changes must be implemented in SWUpdate.
>  
>  Back-end: support for generic down-loader 
> diff --git a/doc/source/swupdate-ipc.rst b/doc/source/swupdate-ipc.rst
> index 402f31b..b64e8b8 100644
> --- a/doc/source/swupdate-ipc.rst
> +++ b/doc/source/swupdate-ipc.rst
> @@ -160,7 +160,7 @@ Activate an already installed Software
>  ......................................
>  
>  After a software was installed, the new software boots and if everything runs fine,
> -an acknowledge should be sent to the Hawkbit server. If this feature is used, for example
> +an acknowledge should be sent to the hawkBit server. If this feature is used, for example
>  to let the end user decide if the new software is accepted, the paramters used by the installation
>  should be stored during the update process.
>  
> diff --git a/suricatta/server_hawkbit.c b/suricatta/server_hawkbit.c
> index 95a0a8b..c9911f1 100644
> --- a/suricatta/server_hawkbit.c
> +++ b/suricatta/server_hawkbit.c
> @@ -55,7 +55,7 @@ static unsigned short mandatory_argument_count = 0;
>  static pthread_mutex_t notifylock = PTHREAD_MUTEX_INITIALIZER;
>  
>  /*
> - * See Hawkbit's API for an explanation
> + * See hawkBit's API for an explanation
>   *
>   */
>  static const char *execution_values[] = { "closed", "proceeding", "canceled","scheduled", "rejected", "resumed", NULL };
> @@ -168,7 +168,7 @@ static inline void server_hakwbit_settoken(const char *type, const char *token)
>  static inline void server_hawkbit_error(const char *s)
>  {
>  	int cnt = server_hawkbit.errorcnt;
> -	/* Store locally just the errors to send them back to hawkbit */
> +	/* Store locally just the errors to send them back to hawkBit */
>  	if ((s) &&
>  		(cnt < HAWKBIT_MAX_REPORTED_ERRORS)) {
>  		server_hawkbit.errors[cnt] = strdup(s);
> @@ -235,7 +235,7 @@ static const char *json_get_deployment_update_action(json_object *json_reply)
>  	}
>  	TRACE("Server delivered unknown 'update' field, skipping..");
>  	/*
> -	 * Hawkbit API has just skip, forced, attempt, this
> +	 * hawkBit API has just skip, forced, attempt, this
>  	 * does not happen
>  	 */
>  	return deployment_update_action.skip;
> @@ -679,7 +679,7 @@ static int server_check_during_dwl(void)
>  	}
>  
>  	/*
> -	 * Send a device Info to the Hawkbit Server
> +	 * Send a device Info to the hawkBit Server
>  	 */
>  	server_op_res_t result =
>  	    server_get_deployment_info(channel, &channel_data, &action_id);
> @@ -738,7 +738,7 @@ server_op_res_t server_has_pending_action(int *action_id)
>  
>  	/*
>  	 * First check if initialization was completed or
> -	 * a feedback should be sent to Hawkbit
> +	 * a feedback should be sent to hawkBit
>  	 */
>  	if (server_hawkbit.update_state == STATE_WAIT) {
>  		return SERVER_OK;
> @@ -768,7 +768,7 @@ server_op_res_t server_has_pending_action(int *action_id)
>  static void add_detail_error(const char *s)
>  {
>  	int cnt = server_hawkbit.errorcnt;
> -	/* Store locally just the errors to send them back to hawkbit */
> +	/* Store locally just the errors to send them back to hawkBit */
>  	if ((s) && (!strncmp(s, "ERROR", 5)) &&
>  		(cnt < HAWKBIT_MAX_REPORTED_ERRORS)) {
>  
> @@ -890,7 +890,7 @@ server_op_res_t server_handle_initial_state(update_state_t stateovrrd)
>  
>  static int server_update_status_callback(ipc_message *msg)
>  {
> -	/* Store locally just the errors to send them back to hawkbit */
> +	/* Store locally just the errors to send them back to hawkBit */
>  	add_detail_error(msg->data.status.desc);
>  
>  	return 0;
> @@ -1131,7 +1131,7 @@ server_op_res_t server_process_update_artifact(int action_id,
>  
>  		/*
>  		 * There is no authorizytion token when file is loaded, because SWU
> -		 * can be on a different server as Hawkbit with a different
> +		 * can be on a different server as hawkBit with a different
>  		 * authorization method.
>  		 */
>  		if (!server_hawkbit.usetokentodwl)
> @@ -1139,7 +1139,7 @@ server_op_res_t server_process_update_artifact(int action_id,
>  
>  		/*
>  		 * Retrieve current time to check download time
> -		 * This is used in the callback to ask again the hawkbit
> +		 * This is used in the callback to ask again the hawkBit
>  		 * server if the download is longer as the polling time
>  		 */
>  
> @@ -1147,7 +1147,7 @@ server_op_res_t server_process_update_artifact(int action_id,
>  
>  		/*
>  		 * Start background task to collect logs and
> -		 * send to Hawkbit server
> +		 * send to hawkBit server
>  		 */
>  		pthread_attr_t attr;
>  		pthread_attr_init(&attr);
> @@ -1571,7 +1571,7 @@ void server_print_help(void)
>  	    "{http,all}_proxy env is tried.\n"
>  	    "\t  -k, --targettoken   Set target token.\n"
>  	    "\t  -g, --gatewaytoken  Set gateway token.\n"
> -	    "\t  -f, --interface     Set the network interface to connect to Hawkbit.\n"
> +	    "\t  -f, --interface     Set the network interface to connect to hawkBit.\n"
>  	    "\t  --disable-token-for-dwl Do not send authentication header when downlloading SWU.\n",
>  	    CHANNEL_DEFAULT_POLLING_INTERVAL, CHANNEL_DEFAULT_RESUME_TRIES,
>  	    CHANNEL_DEFAULT_RESUME_DELAY);
> @@ -1632,7 +1632,7 @@ server_op_res_t server_start(char *fname, int argc, char *argv[])
>  		read_module_settings(fname, "suricatta", server_hawkbit_settings,
>  					NULL);
>  		/*
> -		 * Then try "hawkbit" because each server has its own
> +		 * Then try "hawkBit" because each server has its own
>  		 * section
>  		 */
>  		read_module_settings(fname, "hawkbit", server_hawkbit_settings,
> @@ -1818,7 +1818,7 @@ server_op_res_t server_stop(void)
>  }
>  
>  /*
> - * IPC is to control the Hawkbit's communication
> + * IPC is to control the hawkBit's communication
>   */
>  
>  static server_op_res_t server_activation_ipc(ipc_message *msg)
> 

Applied to -master, thanks !

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/doc/source/conf.py b/doc/source/conf.py
index cdcff47..c6c5e2b 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -236,7 +236,7 @@  man_pages = [
         ('index', 'swupdate', u'Swupdate Documentation', [u'Stefano Babic'], 1),
         ('swupdate-sendtohawkbit', 'sendtohawkbit', u'swupdate-sendtohawkbit tool', '', 1),
         ('swupdate-client', 'client', u'SWUpdate client tool', '', 1),
-        ('swupdate-hawkbitcfg', 'hawkbitcfg', u'SWUpdate Hawkbit Configuration tool', '', 1),
+        ('swupdate-hawkbitcfg', 'hawkbitcfg', u'SWUpdate hawkBit Configuration tool', '', 1),
         ('swupdate-progress', 'progress', u'SWUpdate progress tool', '', 1),
         ('swupdate-sysrestart', 'sysrestart', u'SWUpdate sysrestart tool', '', 1),
         ]
diff --git a/doc/source/hawkbit-setup.rst b/doc/source/hawkbit-setup.rst
index 416f5b9..c90ea65 100644
--- a/doc/source/hawkbit-setup.rst
+++ b/doc/source/hawkbit-setup.rst
@@ -1,13 +1,13 @@ 
 ==========================================================
-Config for HawkBit under SSL/TLS using private CA / sub CA
+Config for hawkBit under SSL/TLS using private CA / sub CA
 ==========================================================
 
-A user-contributed recipe based on HawkBit (0.2.0-SNAPSHOT) + swupdate (v2018.03)
+A user-contributed recipe based on hawkBit (0.2.0-SNAPSHOT) + swupdate (v2018.03)
 
 Purpose
 -------
 
-Use HTTPS on a HawkBit server to avoid server spoofing. Anonymous client connections are authorized.
+Use HTTPS on a hawkBit server to avoid server spoofing. Anonymous client connections are authorized.
 
 Recipe
 ------
@@ -18,9 +18,9 @@  Recipe
  * Use a password on the server key you won't be ashamed of.
  * Also create a single ``.pem`` file for the private CA + sub-CA
 
-2. On the HawkBit host:
+2. On the hawkBit host:
 
- * HawkBit uses the Java KeyStore to access credentials, but a JKS is not designed apparently to hold CA certs, which is a problem for private CAs. The workaround is to make it gulp an entire pkcs#12 file.
+ * hawkBit uses the Java KeyStore to access credentials, but a JKS is not designed apparently to hold CA certs, which is a problem for private CAs. The workaround is to make it gulp an entire pkcs#12 file.
  * It looks like a JKS like this cannot have a password different from the one protecting the ``.p12``. Keytool also seems to have a little tendency to destruct the ``.jks`` if you change your mind and want to change the password... Basically do everything you need with openssl and use only keytool for generating the ``.jks`` file.
 
  The following command imports a ``.p12`` into a "pkcs12 Java keystore", keeping the same password:
@@ -31,10 +31,10 @@  Recipe
           -destkeystore hb-pass.jks -deststoretype pkcs12 \
           -alias 1 -deststorepass <password_of_p12>
 
- Then you need to adapt ``application.properties`` of the HawkBit server to make use of the keystore.
- There are extra requirements to make HawkBit send artifacts via HTTPS.
+ Then you need to adapt ``application.properties`` of the hawkBit server to make use of the keystore.
+ There are extra requirements to make hawkBit send artifacts via HTTPS.
 
- This is the relevant part of ``<HawkBit dir>/hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties``::
+ This is the relevant part of ``<hawkBit dir>/hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties``::
 
   # HTTPS mode working w/ swupdate
   # See also https://docs.spring.io/spring-boot/docs/1.4.7.RELEASE/reference/html/howto-embedded-servlet-containers.html#howto-configure-ssl
diff --git a/doc/source/roadmap.rst b/doc/source/roadmap.rst
index b97ee6a..1c73c9b 100644
--- a/doc/source/roadmap.rst
+++ b/doc/source/roadmap.rst
@@ -123,13 +123,13 @@  if an update must be installed instead of installing and performs checks later.
 If SWUpdate provides a way to inform a checker if an update can be accepted
 before downloading, a download is only done when it is really necessary.
 
-Back-end: Hawkbit Offline support
+Back-end: hawkBit Offline support
 ---------------------------------
 
-There are several discussions on Hawkbit's ML about how to synchronize
+There are several discussions on hawkBit's ML about how to synchronize
 an offline update (done locally or via the internal Web-server) with
-the Hawkbit's server. Currently, Hawkbit thinks to be the only one
-deploying software. Hawkbit DDI API should be extended, and afterwards
+the hawkBit's server. Currently, hawkBit thinks to be the only one
+deploying software. hawkBit DDI API should be extended, and afterwards
 changes must be implemented in SWUpdate.
 
 Back-end: support for generic down-loader 
diff --git a/doc/source/swupdate-ipc.rst b/doc/source/swupdate-ipc.rst
index 402f31b..b64e8b8 100644
--- a/doc/source/swupdate-ipc.rst
+++ b/doc/source/swupdate-ipc.rst
@@ -160,7 +160,7 @@  Activate an already installed Software
 ......................................
 
 After a software was installed, the new software boots and if everything runs fine,
-an acknowledge should be sent to the Hawkbit server. If this feature is used, for example
+an acknowledge should be sent to the hawkBit server. If this feature is used, for example
 to let the end user decide if the new software is accepted, the paramters used by the installation
 should be stored during the update process.
 
diff --git a/suricatta/server_hawkbit.c b/suricatta/server_hawkbit.c
index 95a0a8b..c9911f1 100644
--- a/suricatta/server_hawkbit.c
+++ b/suricatta/server_hawkbit.c
@@ -55,7 +55,7 @@  static unsigned short mandatory_argument_count = 0;
 static pthread_mutex_t notifylock = PTHREAD_MUTEX_INITIALIZER;
 
 /*
- * See Hawkbit's API for an explanation
+ * See hawkBit's API for an explanation
  *
  */
 static const char *execution_values[] = { "closed", "proceeding", "canceled","scheduled", "rejected", "resumed", NULL };
@@ -168,7 +168,7 @@  static inline void server_hakwbit_settoken(const char *type, const char *token)
 static inline void server_hawkbit_error(const char *s)
 {
 	int cnt = server_hawkbit.errorcnt;
-	/* Store locally just the errors to send them back to hawkbit */
+	/* Store locally just the errors to send them back to hawkBit */
 	if ((s) &&
 		(cnt < HAWKBIT_MAX_REPORTED_ERRORS)) {
 		server_hawkbit.errors[cnt] = strdup(s);
@@ -235,7 +235,7 @@  static const char *json_get_deployment_update_action(json_object *json_reply)
 	}
 	TRACE("Server delivered unknown 'update' field, skipping..");
 	/*
-	 * Hawkbit API has just skip, forced, attempt, this
+	 * hawkBit API has just skip, forced, attempt, this
 	 * does not happen
 	 */
 	return deployment_update_action.skip;
@@ -679,7 +679,7 @@  static int server_check_during_dwl(void)
 	}
 
 	/*
-	 * Send a device Info to the Hawkbit Server
+	 * Send a device Info to the hawkBit Server
 	 */
 	server_op_res_t result =
 	    server_get_deployment_info(channel, &channel_data, &action_id);
@@ -738,7 +738,7 @@  server_op_res_t server_has_pending_action(int *action_id)
 
 	/*
 	 * First check if initialization was completed or
-	 * a feedback should be sent to Hawkbit
+	 * a feedback should be sent to hawkBit
 	 */
 	if (server_hawkbit.update_state == STATE_WAIT) {
 		return SERVER_OK;
@@ -768,7 +768,7 @@  server_op_res_t server_has_pending_action(int *action_id)
 static void add_detail_error(const char *s)
 {
 	int cnt = server_hawkbit.errorcnt;
-	/* Store locally just the errors to send them back to hawkbit */
+	/* Store locally just the errors to send them back to hawkBit */
 	if ((s) && (!strncmp(s, "ERROR", 5)) &&
 		(cnt < HAWKBIT_MAX_REPORTED_ERRORS)) {
 
@@ -890,7 +890,7 @@  server_op_res_t server_handle_initial_state(update_state_t stateovrrd)
 
 static int server_update_status_callback(ipc_message *msg)
 {
-	/* Store locally just the errors to send them back to hawkbit */
+	/* Store locally just the errors to send them back to hawkBit */
 	add_detail_error(msg->data.status.desc);
 
 	return 0;
@@ -1131,7 +1131,7 @@  server_op_res_t server_process_update_artifact(int action_id,
 
 		/*
 		 * There is no authorizytion token when file is loaded, because SWU
-		 * can be on a different server as Hawkbit with a different
+		 * can be on a different server as hawkBit with a different
 		 * authorization method.
 		 */
 		if (!server_hawkbit.usetokentodwl)
@@ -1139,7 +1139,7 @@  server_op_res_t server_process_update_artifact(int action_id,
 
 		/*
 		 * Retrieve current time to check download time
-		 * This is used in the callback to ask again the hawkbit
+		 * This is used in the callback to ask again the hawkBit
 		 * server if the download is longer as the polling time
 		 */
 
@@ -1147,7 +1147,7 @@  server_op_res_t server_process_update_artifact(int action_id,
 
 		/*
 		 * Start background task to collect logs and
-		 * send to Hawkbit server
+		 * send to hawkBit server
 		 */
 		pthread_attr_t attr;
 		pthread_attr_init(&attr);
@@ -1571,7 +1571,7 @@  void server_print_help(void)
 	    "{http,all}_proxy env is tried.\n"
 	    "\t  -k, --targettoken   Set target token.\n"
 	    "\t  -g, --gatewaytoken  Set gateway token.\n"
-	    "\t  -f, --interface     Set the network interface to connect to Hawkbit.\n"
+	    "\t  -f, --interface     Set the network interface to connect to hawkBit.\n"
 	    "\t  --disable-token-for-dwl Do not send authentication header when downlloading SWU.\n",
 	    CHANNEL_DEFAULT_POLLING_INTERVAL, CHANNEL_DEFAULT_RESUME_TRIES,
 	    CHANNEL_DEFAULT_RESUME_DELAY);
@@ -1632,7 +1632,7 @@  server_op_res_t server_start(char *fname, int argc, char *argv[])
 		read_module_settings(fname, "suricatta", server_hawkbit_settings,
 					NULL);
 		/*
-		 * Then try "hawkbit" because each server has its own
+		 * Then try "hawkBit" because each server has its own
 		 * section
 		 */
 		read_module_settings(fname, "hawkbit", server_hawkbit_settings,
@@ -1818,7 +1818,7 @@  server_op_res_t server_stop(void)
 }
 
 /*
- * IPC is to control the Hawkbit's communication
+ * IPC is to control the hawkBit's communication
  */
 
 static server_op_res_t server_activation_ipc(ipc_message *msg)