1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-09-30 03:26:23 -04:00

config: Explain why get_opt_rec() does not follow OPT_ALIAS.

This commit is contained in:
Kalle Olavi Niemitalo 2008-02-02 15:59:32 +02:00 committed by Kalle Olavi Niemitalo
parent 1d16e90dca
commit 4960c65f20

View File

@ -157,7 +157,14 @@ debug_check_option_syntax(struct option *option)
/* Ugly kludge */
static int no_autocreate = 0;
/* Get record of option of given name, or NULL if there's no such option. */
/** Get record of option of given name, or NULL if there's no such option.
*
* If the specified option is an ::OPT_ALIAS, this function returns the
* alias, rather than the option to which the alias refers. It must
* work this way because the alias may have the ::OPT_ALIAS_NEGATE flag.
* Instead, if the caller tries to read or set the value of the alias,
* the functions associated with ::OPT_ALIAS will forward the operation
* to the underlying option. */
struct option *
get_opt_rec(struct option *tree, const unsigned char *name_)
{