diff options
Diffstat (limited to '')
| -rw-r--r-- | libenv.h | 74 |
1 files changed, 36 insertions, 38 deletions
@@ -47,7 +47,7 @@ enum libenv_class { /** * Environment variables that describe - * the terminals capabilities + * the terminal's capabilities */ LIBENV_TERMINAL_CAPS, @@ -74,7 +74,7 @@ enum libenv_class { * Environment variables that describe * the current session * - * This for example includes variables + * This includes, for example, variables * added by SSH to describe the remote * connection * @@ -89,8 +89,8 @@ enum libenv_class { * Environment variables that configure * the user's theme * - * This is excludes variables listed - * for LIBENV_THEME_PLUGIN except in the + * This excludes variables listed for + * LIBENV_THEME_PLUGIN, except in the * hypothetical scenario where it names * a plugin and additional configurations */ @@ -103,14 +103,14 @@ enum libenv_class { LIBENV_THEME_PLUGIN, /** - * Environment variables that configures - * the user's internet configurations, + * Environment variables that configure + * the user's Internet connection, * including mainly proxies */ LIBENV_INTERNET, /** - * Environment variables that configures + * Environment variables that configure * the user's audio */ LIBENV_AUDIO, @@ -141,7 +141,7 @@ enum libenv_class { * overwritten for the user) * * Environment variables with this classification - * has at least also LIBENV_PATH + * also have at least LIBENV_PATH */ LIBENV_SYSTEM_PATHS, @@ -150,7 +150,7 @@ enum libenv_class { * configured for the user * * Environment variables with this classification - * has at least also LIBENV_PATH + * also have at least LIBENV_PATH */ LIBENV_USER_PATHS, @@ -159,7 +159,7 @@ enum libenv_class { * current and past working directories * * Environment variables with this classification - * has at least also LIBENV_PATH + * also have at least LIBENV_PATH */ LIBENV_PWD, @@ -190,9 +190,8 @@ enum libenv_class { LIBENV_REMOTE_UNSAFE, /** - * Environment variables that should be can - * safely be kepted when entering a remote - * session + * Environment variables that can safely be + * kept when entering a remote session * * Any environment variable with this * classification has at least one other @@ -202,7 +201,7 @@ enum libenv_class { /** * Environment variables that should be removed - * when entering a logging into a new user + * when logging in as a new user * * Any environment variable with this * classification has at least one other @@ -211,9 +210,8 @@ enum libenv_class { LIBENV_LOGIN_UNSAFE, /** - * Environment variables that should be can - * safely be kepted when entering a logging - * into a new user + * Environment variables that can safely be + * kept when logging in as a new user * * Any environment variable with this * classification has at least one other @@ -232,8 +230,8 @@ enum libenv_class { LIBENV_SU_UNSAFE, /** - * Environment variables that should be can - * safely be kepted when escalating privileges + * Environment variables that can safely be + * kept when escalating privileges * * Any environment variable with this * classification has at least one other @@ -274,7 +272,7 @@ struct libenv_variable { * the list will container their names and classes * * This function does not read the current environment, - * and may return unset environemnt variables + * and may return unset environment variables * * @param nclasswords_out Output parameter for the number of elements in each returned * `struct libenv_variable`'s `.classes`, may be `NULL` @@ -296,7 +294,7 @@ LIBENV_RET_NONNULL__ const struct libenv_variable *libenv_get_complete_list(size * statically allocated and should not be deallocated or modified, * `NULL` on failure * - * @throws ENOMEM Not enought memory available to allocate the list + * @throws ENOMEM Not enough memory available to allocate the list */ LIBENV_MALLOC__ const char **libenv_vget_chosen_list(enum libenv_class, va_list); @@ -312,7 +310,7 @@ LIBENV_MALLOC__ const char **libenv_vget_chosen_list(enum libenv_class, va_list) * statically allocated and should not be deallocated or modified, * `NULL` on failure * - * @throws ENOMEM Not enought memory available to allocate the list + * @throws ENOMEM Not enough memory available to allocate the list */ LIBENV_MALLOC__ const char **libenv_get_chosen_list(enum libenv_class, ... /*, LIBENV_END */); @@ -320,7 +318,7 @@ LIBENV_MALLOC__ const char **libenv_get_chosen_list(enum libenv_class, ... /*, L * Given a list of environment variable names, remove the variables * that belong to all of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -333,7 +331,7 @@ size_t libenv_vfilter_name_list(const char **, va_list); * Given a list of environment variable names, remove the variables * that belong to all of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -347,7 +345,7 @@ size_t libenv_filter_name_list(const char **, /* enum libenv_class */ ... /*, LI * Given a list of environment variables, with values, remove the variables * that belong to all of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -360,7 +358,7 @@ size_t libenv_vfilter_variable_list(const char **, va_list); * Given a list of environment variables, with values, remove the variables * that belong to all of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -374,7 +372,7 @@ size_t libenv_filter_variable_list(const char **, /* enum libenv_class */ ... /* * Given a list of environment variable names, remove any variable that * does not belong to any of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -387,7 +385,7 @@ size_t libenv_vselect_name_list(const char **, va_list); * Given a list of environment variable names, remove any variable that * does not belong to any of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -401,7 +399,7 @@ size_t libenv_select_name_list(const char **, /* enum libenv_class */ ... /*, LI * Given a list of environment variables, with values, remove any variable * that does not belong to any of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -414,7 +412,7 @@ size_t libenv_vselect_variable_list(const char **, va_list); * Given a list of environment variables, with values, remove any variable * that does not belong to any of the specified environment variable classes * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -431,7 +429,7 @@ size_t libenv_select_variable_list(const char **, /* enum libenv_class */ ... /* * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -447,7 +445,7 @@ size_t libenv_vfilter_name_list_with_dealloc(char **, va_list); * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -464,7 +462,7 @@ size_t libenv_filter_name_list_with_dealloc(char **, /* enum libenv_class */ ... * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -480,7 +478,7 @@ size_t libenv_vfilter_variable_list_with_dealloc(char **, va_list); * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -497,7 +495,7 @@ size_t libenv_filter_variable_list_with_dealloc(char **, /* enum libenv_class */ * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -513,7 +511,7 @@ size_t libenv_vselect_name_list_with_dealloc(char **, va_list); * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variable names; may be `NULL`, + * @param variables `NULL`-terminated list environment variable names; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, @@ -530,7 +528,7 @@ size_t libenv_select_name_list_with_dealloc(char **, /* enum libenv_class */ ... * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param classes The list of environment variable classes, must end with `LIBENV_END` @@ -546,7 +544,7 @@ size_t libenv_vselect_variable_list_with_dealloc(char **, va_list); * Any element removed from `variables` will be deallocated using * the free(3) function * - * @param variables `NULL`-terminated list environemnt variables; may be `NULL`, + * @param variables `NULL`-terminated list environment variables; may be `NULL`, * which causes the function to return 0; unless `NULL` the list * will be updated * @param ... The list of environment variable classes, must end with `LIBENV_END`, |