retire ERROR_INVALID_ARGUMENTS and replace with ERROR_COMMAND_SYNTAX_ERROR

Change-Id: I6dee51e1fab1944085391f274a343cdb9014c7a4
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Reviewed-on: http://openocd.zylin.com/300
Tested-by: jenkins
Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>

5 files changed, 20 insertions, 21 deletions

diff --git a/src/helper/command.c b/src/helper/command.c
index 65e538b..3ed8dc8 100644
--- a/src/helper/command.c
+++ b/src/helper/command.c
@@ -494,7 +494,7 @@ int unregister_command(struct command_context *context,
 		struct command *parent, const char *name)
 {
 	if ((!context) || (!name))
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 
 	struct command *p = NULL;
 	struct command **head = command_list_for_parent(context, parent);
@@ -832,12 +832,12 @@ static COMMAND_HELPER(command_help_find, struct command *head,
 		struct command **out)
 {
 	if (0 == CMD_ARGC)
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	*out = command_find(head, CMD_ARGV[0]);
 	if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
 		*out = command_find(head, CMD_ARGV[0] + 4);
 	if (NULL == *out)
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	if (--CMD_ARGC == 0)
 		return ERROR_OK;
 	CMD_ARGV++;
@@ -1180,7 +1180,7 @@ COMMAND_HANDLER(handle_help_add_command)
 	if (CMD_ARGC < 2)
 	{
 		LOG_ERROR("%s: insufficient arguments", CMD_NAME);
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	// save help text and remove it from argument list
@@ -1190,7 +1190,7 @@ COMMAND_HANDLER(handle_help_add_command)
 	if (!help && !usage)
 	{
 		LOG_ERROR("command name '%s' is unknown", CMD_NAME);
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 	// likewise for the leaf command name
 	const char *cmd_name = CMD_ARGV[--CMD_ARGC];
@@ -1399,7 +1399,7 @@ struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp
 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
 {
 	if (!cmd_ctx)
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 
 	cmd_ctx->mode = mode;
 	return ERROR_OK;
@@ -1503,7 +1503,7 @@ int command_parse_bool_arg(const char *in, bool *out)
 		return ERROR_OK;
 	if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
 		return ERROR_OK;
-	return ERROR_INVALID_ARGUMENTS;
+	return ERROR_COMMAND_SYNTAX_ERROR;
 }
 
 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
@@ -1514,7 +1514,7 @@ COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
 		if (command_parse_bool_arg(in, out) != ERROR_OK)
 		{
 			LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
-			return ERROR_INVALID_ARGUMENTS;
+			return ERROR_COMMAND_SYNTAX_ERROR;
 		}
 		// fall through
 	}
@@ -1522,7 +1522,7 @@ COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
 		LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
 		break;
 	default:
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 	return ERROR_OK;
 }
diff --git a/src/helper/fileio.c b/src/helper/fileio.c
index 9ae0134..b97ebf4 100644
--- a/src/helper/fileio.c
+++ b/src/helper/fileio.c
@@ -63,7 +63,7 @@ static inline int fileio_open_local(struct fileio_internal *fileio)
 			break;
 		default:
 			LOG_ERROR("BUG: access neither read, write nor readwrite");
-			return ERROR_INVALID_ARGUMENTS;
+			return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	/* win32 always opens in binary mode */
diff --git a/src/helper/ioutil.c b/src/helper/ioutil.c
index 211c4ba..3754fc5 100644
--- a/src/helper/ioutil.c
+++ b/src/helper/ioutil.c
@@ -118,7 +118,7 @@ COMMAND_HANDLER(handle_cat_command)
 	if (CMD_ARGC != 1)
 	{
 		command_print(CMD_CTX, "cat <filename>");
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	// NOTE!!! we only have line printing capability so we print the entire file as a single line.
@@ -144,7 +144,7 @@ COMMAND_HANDLER(handle_trunc_command)
 	if (CMD_ARGC != 1)
 	{
 		command_print(CMD_CTX, "trunc <filename>");
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	FILE *config_file = NULL;
@@ -163,7 +163,7 @@ COMMAND_HANDLER(handle_meminfo_command)
 	if (CMD_ARGC != 0)
 	{
 		command_print(CMD_CTX, "meminfo");
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	info = mallinfo();
@@ -186,7 +186,7 @@ COMMAND_HANDLER(handle_append_command)
 	{
 		command_print(CMD_CTX,
 				"append <filename> [<string1>, [<string2>, ...]]");
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	int retval = ERROR_FAIL;
@@ -224,7 +224,7 @@ COMMAND_HANDLER(handle_cp_command)
 {
 	if (CMD_ARGC != 2)
 	{
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	// NOTE!!! we only have line printing capability so we print the entire file as a single line.
@@ -237,7 +237,7 @@ COMMAND_HANDLER(handle_cp_command)
 
 	FILE *f = fopen(CMD_ARGV[1], "wb");
 	if (f == NULL)
-		retval = ERROR_INVALID_ARGUMENTS;
+		retval = ERROR_COMMAND_SYNTAX_ERROR;
 
 	size_t pos = 0;
 	for (;;)
@@ -250,7 +250,7 @@ COMMAND_HANDLER(handle_cp_command)
 		}
 
 		if ((retval == ERROR_OK) && (fwrite(((char *)data) + pos, 1, chunk, f) != chunk))
-			retval = ERROR_INVALID_ARGUMENTS;
+			retval = ERROR_COMMAND_SYNTAX_ERROR;
 
 		if (retval != ERROR_OK)
 		{
@@ -405,7 +405,7 @@ void copydir(char *name, char *destdir)
 COMMAND_HANDLER(handle_rm_command)
 {
 	if (CMD_ARGC != 1)
-		return ERROR_INVALID_ARGUMENTS;
+		return ERROR_COMMAND_SYNTAX_ERROR;
 
 	bool del = false;
 	if (rmdir(CMD_ARGV[0]) == 0)
diff --git a/src/helper/log.c b/src/helper/log.c
index 8a8f08a..fa66de0 100644
--- a/src/helper/log.c
+++ b/src/helper/log.c
@@ -326,7 +326,7 @@ int log_add_callback(log_callback_fn fn, void *priv)
 	for (cb = log_callbacks; cb; cb = cb->next)
 	{
 		if (cb->fn == fn && cb->priv == priv)
-			return ERROR_INVALID_ARGUMENTS;
+			return ERROR_COMMAND_SYNTAX_ERROR;
 	}
 
 	/* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
@@ -357,7 +357,7 @@ int log_remove_callback(log_callback_fn fn, void *priv)
 	}
 
 	/* no such item */
-	return ERROR_INVALID_ARGUMENTS;
+	return ERROR_COMMAND_SYNTAX_ERROR;
 }
 
 /* return allocated string w/printf() result */
diff --git a/src/helper/log.h b/src/helper/log.h
index 801ae7f..7edfa7b 100644
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -132,7 +132,6 @@ extern int debug_level;
  * error codes < 100
  */
 #define ERROR_OK					(0)
-#define ERROR_INVALID_ARGUMENTS		ERROR_COMMAND_SYNTAX_ERROR
 #define ERROR_NO_CONFIG_FILE		(-2)
 #define ERROR_BUF_TOO_SMALL			(-3)
 /* see "Error:" log entry for meaningful message to the user. The caller should