| Subject: | Docs on manipulating %Config unclear |
Module::Build::Config is not documented which leaves the proper use of
$self->{config} up in the air as illustrated by [rt.cpan.org 27994].
Maybe it shouldn't be, but the docs are a little confusing on that point.
From Module::Build
-----------------
The build process also relies heavily on the Config.pm module, and all
the key=value pairs in Config.pm are available in
$self->{config}. If the user wishes to override any of the values in
Config.pm, she may specify them like so:
perl Build.PL --config cc=gcc --config ld=gcc
-----------------
This suggests to grab at $self->{config} and use it as a hash ref.
That's wrong. Since $self->{config} is grabbing at internals that's
user-level documentation, not authoring, its mention should probably
just be deleted.
From Module::Build::API
------------------
config($key)
config($key, $value)
config() [deprecated]
[version 0.22]
With a single argument $key, returns the value associated with that
key in the Config.pm hash, including any changes the author or user has
specified.
With $key and $value arguments, sets the value for future callers of
config($key).
With no arguments, returns a hash reference containing all such
key-value pairs. This usage is deprecated, though, because it's a
resource hog and violates encapsulation.
-----------------
This appears to be the correct way to play with %Config in MB but its
the only mention I can find. A cookbook mention would be helpful.