view release on metacpan or  search on metacpan

README  view on Meta::CPAN

# Developer's notes for Advanced::Config ...

# This module is a powerful config file manager that treats your config files
# as objects to access.  It provides many different features that make it
# more useful than many of the competing config file modules.  And most of its
# features are very configurable to meet your individual needs.

# It's main goal is to be able to take config files from various sources and
# products and to be able to use them natively in this module.  Making any
# config file look the same to a Perl program!

# See the many test cases and config files for how powerful things can be.
# Once you start using it I don't see you going back to using any other
# config file module.

# This module makes heavy use of Fred::Fish::DBUG to provide tracing for the
# test cases and to help with debugging this code.  But this logging feature is
# turned off for normal operations.  But it's still a prerequisite for using
# this module.

# Run "perldoc Advanced::Config::Examples"  for more details & examples
# in using Advanced::Config once this module has been installed.


INSTALLATION
=====================================================================

To install this module in the default location type the following:

   perl Makefile.PL
   make
   make test
   make install

To install this module in an alternate location do:

   location=<install-location>
   perl Makefile.PL INSTALL_BASE=${location}
   make
   make test
   make install

Then set PERL5LIB to "${location}/lib/perl5".


# -----------------------------------------------------------------------------
# Reporting a bug in Advanced::Config
# -----------------------------------------------------------------------------
Support is very limited, but I will do my best to help resolve any problems
you have with my module if you provide the following files demonstrating the
bug/issue you are hitting.
 1) A sample config file.
 2) A sample program that uses the config file and demonstrates the bug.
 3) The fish log generated.  (optional)  But I'll request one if the issue
    isn't reproducible on my end with what you gave me.

If it's a true bug, I'll probably use your sample program as the basis for a
new test case in a future release.

See a section below on how to turn on the logs of Fred::Fish::DBUG that
Advanced::Config uses to trace it's functionality to show why the code is
having issues.

# -----------------------------------------------------------------------------
# What if a test case fails?
# -----------------------------------------------------------------------------
In this case there should already be logs to send out.  Each and every test
program that comes with this module generates very verbose logging of what's
happening.  So just open a CPAN ticket and attach the log to the ticket.  Do
not cut and paste the logs contents into the ticket!  It just makes the ticket
unreadable.

These logs can be found under t/log_details/*.txt

# -----------------------------------------------------------------------------
# What if it's your program that's failing?
# Then you need to turn on Fred::Fish::DBUG tracing used by Advanced::Config.