make syntax errors respond with 'usage'

[openocd.git] / src / helper / command.h

diff --git a/src/helper/command.h b/src/helper/command.h
index 2d3348468f3ca541a4e57c868e80693bdebb3df7..07235961b1ddc236f215432864bee3d1755c29b7 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -62,20 +62,6 @@ struct command_context
        enum command_mode mode;
        struct command *commands;
        int current_target;
-       /* Execute a command.
-        *
-        * If the command fails, it *MUST* return a value != ERROR_OK
-        * (many commands break this rule, patches welcome!)
-        *
-        * This is *especially* important for commands such as writing
-        * to flash or verifying memory. The reason is that those commands
-        * can be used by programs to determine if the operation succeded
-        * or not. If the operation failed, then a program can try
-        * an alternative approach.
-        *
-        * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
-        * printing out the syntax of the command.
-        */
        command_output_handler_t output_handler;
        void *output_handler_priv;
 };
@@ -166,7 +152,23 @@ struct command_invocation {
 #define CMD_DATA CMD_CURRENT->jim_handler_data
 
 
-/// The type signature for commands' handler functions.
+/**
+ * The type signature for command handling functions.  They are
+ * usually registered as part of command_registration, providing
+ * a high-level means for executing a command.
+ *
+ * If the command fails, it *MUST* return a value != ERROR_OK
+ * (many commands break this rule, patches welcome!)
+ *
+ * This is *especially* important for commands such as writing
+ * to flash or verifying memory. The reason is that those commands
+ * can be used by programs to determine if the operation succeded
+ * or not. If the operation failed, then a program can try
+ * an alternative approach.
+ *
+ * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
+ * printing out the syntax of the command.
+ */
 typedef __COMMAND_HANDLER((*command_handler_t));
 
 struct command
@@ -316,7 +318,6 @@ void command_set_handler_data(struct command *c, void *p);
 void command_set_output_handler(struct command_context* context,
                command_output_handler_t output_handler, void *priv);
 
-struct command_context* copy_command_context(struct command_context* context);
 
 int command_context_mode(struct command_context *context, enum command_mode mode);
 
@@ -324,7 +325,21 @@ int command_context_mode(struct command_context *context, enum command_mode mode
  * Creates a new command context using the startup TCL provided.
  */
 struct command_context* command_init(const char *startup_tcl);
-int command_done(struct command_context *context);
+/**
+ * Creates a copy of an existing command context.  This does not create
+ * a deep copy of the command list, so modifications in one context will
+ * affect all shared contexts.  The caller must track reference counting
+ * and ensure the commands are freed before destroying the last instance.
+ * @param cmd_ctx The command_context that will be copied.
+ * @returns A new command_context with the same state as the original.
+ */
+struct command_context* copy_command_context(struct command_context* cmd_ctx);
+/**
+ * Frees the resources associated with a command context.  The commands
+ * are not removed, so unregister_all_commands() must be called first.
+ * @param cmd_ctx The command_context that will be destroyed.
+ */
+void command_done(struct command_context *context);
 
 void command_print(struct command_context *context, const char *format, ...)
                __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));