Next: Glib::Markup | Previous: Glib::MainLoop | [Gtk2-Perl - Table of Contents] | [Gtk2-Perl - Index] |
Glib::MakeHelper - Makefile.PL utilities for Glib-based extensions
eval "use Glib::MakeHelper; 1" or complain_that_glib_is_too_old_and_die(); %xspod_files = Glib::MakeHelper->do_pod_files (@xs_files); package MY; sub postamble { return Glib::MakeHelper->postamble_clean () . Glib::MakeHelper->postamble_docs (@main::xs_files) . Glib::MakeHelper->postamble_rpms ( MYLIB => $build_reqs{MyLib}, ); }
The Makefile.PL for your typical Glib-based module is huge and hairy, thanks to all the crazy hoops you have to jump through to get things right. This module wraps up some of the more intense and error-prone bits to reduce the amount of copied code and potential for errors.
disable-apidoc
an empty list will be returned and thus no apidoc
pod will be generated speeding up the build process.
configure_requires
key. This can be used with
ExtUtils::MakeMaker's EXTRA_META
parameter to specify which modules are
needed at Makefile.PL time.
This function is deprecated since ExtUtils::MakeMaker 6.46 removed
support for EXTRA_META
in favor of the new keys META_MERGE
and
META_ADD
.
The reasoning behind using this instead of just having you use the 'clean' or 'realclean' keys is that this avoids you having to remember to put Glib's stuff in your Makefile.PL's WriteMakefile arguments.
Create and return the text of Makefile rules to build documentation from the XS files with Glib::ParseXSDoc and Glib::GenPod.
Use this in your MY::postamble to enable autogeneration of POD.
This updates dependencies with the list of pod names generated by an earlier
run of do_pod_files
.
There is a special Makefile variable POD_DEPENDS that should be set to the list of files that need to be created before the doc.pl step is run, include files.
There is also a variable BLIB_DONE which should be used as a dependency anywhere a rule needs to be sure that a loadable and working module resides in the blib directory before running.
Use this in your MY::postamble to enable autogeneration of POD.
This updates dependencies with the list of pod names generated by an earlier
run of do_pod_files
.
There is a special Makefile variable POD_DEPENDS that should be set to the list of files that need to be created before the doc.pl step is run, include files.
There is also a variable BLIB_DONE which should be used as a dependancy anywhere a rule needs to be sure that a loadable and working module resides in the blib directory before running.
The parameters are a list of key=>value pairs. You must specify at minimum either DEPENDS or XS_FILES.
Glib::GenPod::add_types
. May be omitted.
HASH is a set of search and replace keys for the spec file. All occurences of @key@ in the spec file template perl-$(DISTNAME).spec.in will be replaced with value. 'VERSION' and 'SOURCE' are supplied for you. For example:
Glib::MakeHelper->postamble_rpms ( MYLIB => 2.0.0, # we can work with anything from this up MYLIB_RUN => 2.3.1, # we are actually compiled against this one PERL_GLIB => 1.01, # you must have this version of Glib );
will replace @MYLIB@, @MYLIB_RUN@, and @PERL_GLIB@ in spec file. See the build setups for Glib and Gtk2 for examples.
Note: This function just returns an empty string on Win32.
postamble_clean
, all temporary files will be removed by the 'realclean'
target.
The MakeMaker distributed with perl 5.8.x generates makefiles with a bug that causes object files to be created in the wrong directory. There is an override inserted by this module under the name MY::const_cccmd to fix this issue.
Ross McFarland <rwmcfa1 at neces dot com>
hacked up and documented by muppet.
Copyright 2003-2004 by the gtk2-perl team
This library is free software; you can redistribute it and/or modify it under the terms of the Lesser General Public License (LGPL). For more information, see http://www.fsf.org/licenses/lgpl.txt