summaryrefslogtreecommitdiff
path: root/cmd/net.c
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2025-03-05 17:25:16 -0700
committerTom Rini <trini@konsulko.com>2025-03-18 13:12:15 -0600
commit3ccbc10cd9e3b28d67fe5008943a648b870db1e6 (patch)
treeea2f387c1192cea46db8864ca483a7a3502e47e1 /cmd/net.c
parent2c04afbc957d18e61813315a0694db903754a280 (diff)
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>
Diffstat (limited to 'cmd/net.c')
-rw-r--r--cmd/net.c13
1 files changed, 11 insertions, 2 deletions
diff --git a/cmd/net.c b/cmd/net.c
index deebd5b710f..89a4d9b38d4 100644
--- a/cmd/net.c
+++ b/cmd/net.c
@@ -313,9 +313,18 @@ static int parse_addr_size(char * const argv[])
/**
* 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[])