minor suggestion for clarification of wildcards explanation in manual

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

minor suggestion for clarification of wildcards explanation in manual

Robert P. J. Day-2

  section 4.3:

"Wildcard expansion is performed by make automatically in targets and
in prerequisites. In recipes, the shell is responsible for wildcard
expansion. In other contexts, wildcard expansion happens only if you
request it explicitly with the wildcard function."

  if someone is new to make and their focus until now has been on
rules and targets and prerequisites and recipes, they might be
confused about this explanation about "other contexts," thinking,
"what other contexts *are* there? doesn't targets and prereqs and
recipes pretty much cover it?"

  admittedly, a bit further down, this is clarified:

"Wildcard expansion happens automatically in rules. But wildcard
expansion does not normally take place when a variable is set, or
inside the arguments of a function."

  if it were me, i would extend that earlier passage with a few words
like, "In other contexts (such as variable assignment and inside
function arguments, explained shortly), wildcard expansion happens
only if you request it explicitly with the wildcard function."

  that way, the reader knows immediately that there's more coming so
they don't puzzle over this.

rday

--

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                         http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================