[Bug 66153] New: mod_macro documentation: examples use ${...} syntax for macro arguments, conflicting with Define ${...} syntax

[bugzilla]

https://bz.apache.org/bugzilla/show_bug.cgi?id=66153

            Bug ID: 66153
           Summary: mod_macro documentation: examples use ${...} syntax
                    for macro arguments, conflicting with Define ${...}
                    syntax
           Product: Apache httpd-2
           Version: 2.4-HEAD
          Hardware: All
               URL: https://httpd.apache.org/docs/2.4/mod/mod_macro.html#t
                    ips
                OS: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
          Assignee: docs@httpd.apache.org
          Reporter: dsem...@gmail.com
  Target Milestone: ---

The documentation for mod_macro under Tips:

    https://httpd.apache.org/docs/2.4/mod/mod_macro.html#tips

provides an example using the ${...} syntax for macro arguments.  Attemping to
use
this in an actual Apache configuration:

    <Macro VHost ${domain} ${suffix} ${dir}>
        <VirtualHost *:80>
            ServerName  www.${domain}.${suffix}
            ServerAlias ${domain}.${suffix}
            # ...
            ErrorLog ${APACHE_LOG_DIR}/${domain}.${suffix}-error.log
            CustomLog ${APACHE_LOG_DIR}/${domain}.${suffix}-access.log combined
        </VirtualHost>
        # ...
    </Macro>

results in a few occurrences of the following warning:

    [macro:warn] [pid 29527] AH02805: macro 'vhost' (defined on line 5 of
"/etc/apache2/sites-enabled/100-macro-sites.conf") argument name '${domain}'
(#1) clashes with 'Define' syntax '${...}', better use '$(...)'.

Fixing all occurrences of ${...} to use the $(...) syntax, **except** for
things like ${APACHE_LOG_DIR}, silences the warning.

Documentation should be modified to use the $(...) syntax instead of ${...}
syntax for macro arguments, including in the <Macro> line.

-- 
You are receiving this mail because:
You are the assignee for the bug.
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscr...@httpd.apache.org
For additional commands, e-mail: docs-h...@httpd.apache.org