https://bugs.exim.org/show_bug.cgi?id=3018

--- Comment #5 from u34 <u...@net9.cf> ---
Let me start from the beginning, describing the problem I am trying to solve:
When reading an exim configuration I sometimes search the documentation for
various pieces. Suppose I want to understand how an address_data option impact
a router operation. And find myself reading the address_data section at
https://exim.org/exim-html-current/doc/html/spec_html/ch-generic_options_for_routers.html:

    address_data     Use: routers     Type: string†     Default: unset

    The string is expanded just before the router is run, that is, after all
the precondition tests have succeeded. If the ...

Now I notice there is a † character here. So I ask myself what does it mean? I
have to further look in the documentation to find what the dagger means. Where
is the meaning of the † character explained? A † is not mentioned in the table
of contents. Neither I can see it in
https://exim.org/exim-html-current/doc/html/spec_html/ch-concept_index.html. Or
at https://exim.org/exim-html-current/doc/html/spec_html/ch-option_index.html,
or at
https://exim.org/exim-html-current/doc/html/spec_html/ch-variable_index.html.
When I keep looking I eventually find
https://exim.org/exim-html-current/doc/html/spec_html/ch-main_configuration.html#SECTalomo
:

    Those options that undergo string expansion before use are marked with †.

Or the beginning of
https://exim.org/exim-html-current/doc/html/spec_html/ch-string_expansions.html
:

    in this documentation, options for which string expansion is performed are
marked with † after the data type.

But I wonder why not get helped by mention it either at
https://exim.org/exim-html-current/doc/html/spec_html/ch-concept_index.html? Or
at https://exim.org/exim-html-current/doc/html/spec_html/ch-option_index.html,
or at
https://exim.org/exim-html-current/doc/html/spec_html/ch-variable_index.html?

And a similar reasoning for asking for ‡ (&Dagger;) to be mentioned at one of
https://exim.org/exim-html-current/doc/html/spec_html/ch-concept_index.html,
https://exim.org/exim-html-current/doc/html/spec_html/ch-option_index.html, or
at
https://exim.org/exim-html-current/doc/html/spec_html/ch-variable_index.html.

-- 
You are receiving this mail because:
You are on the CC list for the bug.

-- 
## subscription configuration (requires account):
##   https://lists.exim.org/mailman3/postorius/lists/exim-dev.lists.exim.org/
## unsubscribe (doesn't require an account):
##   exim-dev-unsubscr...@lists.exim.org
## Exim details at http://www.exim.org/
## Please use the Wiki with this list - http://wiki.exim.org/

Reply via email to