net: Tidy up the comments to parse_args()
This function is a bit vague as to what it does. Expand the comment a
little, to specify which args are provided and which variables are
updated.
Signed-off-by: Simon Glass <sjg@chromium.org>
Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
diff --git a/cmd/net.c b/cmd/net.c
index deebd5b..89a4d9b 100644
--- a/cmd/net.c
+++ b/cmd/net.c
@@ -313,9 +313,18 @@
/**
* parse_args() - parse command line arguments
*
+ * Sets:
+ *
+ * - net_boot_file_name_explicit to true if a filename was specified
+ * - net_boot_file_name to that filename, if specified, else the value of the
+ * 'bootfile' environment variable
+ * - image_load_addr if a load address was provided
+ * - image_save_addr and image_save_size, if proto == TFTPPUT
+ *
* @proto: command prototype
- * @argc: number of arguments
- * @argv: command line arguments
+ * @argc: number of arguments, include the command, which has already been
+ * parsed
+ * @argv: command line arguments, with argv[0] being the command
* Return: 0 on success
*/
static int parse_args(enum proto_t proto, int argc, char *const argv[])