common: command: Handle USAGE failure separately

[oweals/u-boot.git] / include / command.h

diff --git a/include/command.h b/include/command.h
index 04cd1e745cbfbbb4fa15170ff2181160e1fbde84..5b1577f3b4774f6f685efb02bd8f26ee481dd444 100644 (file)
--- a/include/command.h
+++ b/include/command.h
@@ -67,7 +67,9 @@ extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *
  *
  * @cmdtp: Command which caused the error
  * @err: Error code (0 if none, -ve for error, like -EIO)
- * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
+ * @return 0 (CMD_RET_SUCCESX) if there is not error,
+ *        1 (CMD_RET_FAILURE) if an error is found
+ *        -1 (CMD_RET_USAGE) if 'usage' error is found
  */
 int cmd_process_error(cmd_tbl_t *cmdtp, int err);