diff options
author | Tony Crisci <tony@dubstepdish.com> | 2017-11-11 10:44:29 -0500 |
---|---|---|
committer | Tony Crisci <tony@dubstepdish.com> | 2017-11-11 10:44:29 -0500 |
commit | 18079e234a9fb8ee3ee8686cf3e28d5920326a4a (patch) | |
tree | 7ef1bfaa938e3a2d8add0578d5e265a7785df3a4 /include/rootston | |
parent | 6e00140e8a0326ce1d78c1c3efd8b0a373298af0 (diff) |
rootston: documentation for config.h functions
Diffstat (limited to 'include/rootston')
-rw-r--r-- | include/rootston/config.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/include/rootston/config.h b/include/rootston/config.h index 8ef58100..d2a25b5b 100644 --- a/include/rootston/config.h +++ b/include/rootston/config.h @@ -58,8 +58,16 @@ struct roots_config { char *startup_cmd; }; +/** + * Create a roots config from the given command line arguments. Command line + * arguments can specify the location of the config file. If it is not + * specified, the default location will be used. + */ struct roots_config *parse_args(int argc, char *argv[]); +/** + * Destroy the config and free its resources. + */ void roots_config_destroy(struct roots_config *config); /** |