Message ID | 1392034997-12394-8-git-send-email-francois.perrad@gadz.org |
---|---|
State | Superseded |
Headers | show |
On 02/10/14 13:23, Francois Perrad wrote: > > Signed-off-by: Francois Perrad <francois.perrad@gadz.org> > --- > docs/manual/adding-packages-perl.txt | 110 ++++++++++++++++++++++++++++++++++ > docs/manual/adding-packages.txt | 2 + > 2 files changed, 112 insertions(+) > create mode 100644 docs/manual/adding-packages-perl.txt > > diff --git a/docs/manual/adding-packages-perl.txt b/docs/manual/adding-packages-perl.txt > new file mode 100644 > index 0000000..1e48df9 > --- /dev/null > +++ b/docs/manual/adding-packages-perl.txt > @@ -0,0 +1,110 @@ > +// -*- mode:doc; -*- > +// vim: set syntax=asciidoc: > + > +Infrastructure for Perl/CPAN packages > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > + > +[[perl-package-tutorial]] > + > ++perl-package+ tutorial > +^^^^^^^^^^^^^^^^^^^^^^^ > + > +First, let's see how to write a +.mk+ file for a Perl/CPAN package, > +with an example : > + > +------------------------ > +01: ################################################################################ > +02: # > +03: # perl-foo-bar > +04: # > +05: ################################################################################ > +06: > +07: PERL_FOO_BAR_VERSION = 0.02 > +08: PERL_FOO_BAR_SOURCE = Foo-Bar-$(PERL_FOO_BAR_VERSION).tar.gz > +09: PERL_FOO_BAR_SITE = $(BR2_CPAN_MIRROR)/authors/id/M/MO/MONGER/ > +10: PERL_FOO_BAR_DEPENDENCIES = perl-strictures > +11: PERL_FOO_BAR_LICENSE = perl_5 Should be "Artistic or GPLv1+" > +12: PERL_FOO_BAR_LICENSE_FILES = LICENSE > +13: > +14: $(eval $(perl-package)) > +------------------------ > + > +On line 7, we declare the version of the package. > + > +On line 8 and 9, we declare the name of the tarball and the location > +of the tarball on a CPAN server. Buildroot will automatically download > +the tarball from this location. > + > +On line 10, we declare our dependencies, so that they are built > +before the build process of our package starts. > + > +On line 11 and 12, we give licensing details about the package (its > +license on line 11, and the file containing the license text on line > +12). > + > +Finally, on line 14, we invoke the +perl-package+ macro that > +generates all the Makefile rules that actually allow the package to be > +built. > + > +Most of these data could be retrieved from https://metacpan.org/. > +So, this file and the Config.in could be generated by running > +the script +supports/scripts/scancpan Foo-Bar+ in the +TOPDIR+ directory > +(or in the +BR2_EXTERNAL+ directory). > +This script recursively creates packages for all required Perl/CPAN > +dependencies. > + > +[[perl-package-reference]] > + > ++perl-package+ reference > +^^^^^^^^^^^^^^^^^^^^^^^^ > + > +As a policy, packages that provide Perl/CPAN modules should all be > +named +perl-<something>+ in Buildroot. > + > +This infrastructure handles various Perl build systems : > ++ExtUtils-MakeMaker+, +Module-Build+ and +Module-Build-Tiny+. > ++Build.PL+ is always prefered when a package provides a +Makefile.PL+ preferred > +and a +Build.PL+. > + > +The main macro of the Perl/CPAN package infrastructure is > ++perl-package+. It is similar to the +generic-package+ macro. The ability to > +have target and host packages is also available, with the > ++host-perl-package+ macro. > + > +Just like the generic infrastructure, the Perl/CPAN infrastructure > +works by defining a number of variables before calling the > ++perl-package+ macro. > + > +First, all the package metadata information variables that exist in the > +generic infrastructure also exist in the Perl/CPAN infrastructure: > ++PERL_FOO_VERSION+, +PERL_FOO_SOURCE+, > ++PERL_FOO_PATCH+, +PERL_FOO_SITE+, > ++PERL_FOO_SUBDIR+, +PERL_FOO_DEPENDENCIES+, > ++PERL_FOO_INSTALL_TARGET+. > + > +Note that: > + > + * Setting +PERL_FOO_INSTALL_STAGING+ to +YES+ has no effect (unless > + a +PERL_FOO_INSTALL_STAGING_CMDS+ variable is defined), since > + Perl modules generally don't need to be installed to the > + +staging+ directory. Note that setting +PERL_FOO_INSTALL_STAGING+ to +YES+ has no effect unless a +PERL_FOO_INSTALL_STAGING_CMDS+ variable is defined. The perl infrastructure doesn't define this since Perl modules generally don't need to be installed to the +staging+ directory. Regards, Arnout > + > +A few additional variables, specific to the Perl/CPAN infrastructure, > +can also be defined. Many of them are only useful in very specific > +cases, typical packages will therefore only use a few of them. > + > +* +PERL_FOO_CONF_OPT+, to specify additional configure > + options to pass to the +perl Makefile.PL+ or +perl Build.PL+. > + By default, empty. > + > +* +PERL_FOO_BUILD_OPT+, to specify additional options to > + pass to +make pure_all+ or +perl Build build+ in the build step. > + By default, empty. > + > +* +PERL_FOO_INSTALL_TARGET_OPT+, to specify additional options to > + pass to +make pure_install+ or +perl Build install+ in the install step. > + By default, empty. > + > +* +HOST_PERL_FOO_INSTALL_OPT+, to specify additional options to > + pass to +make pure_install+ or +perl Build install+ in the install step. > + By default, empty. > diff --git a/docs/manual/adding-packages.txt b/docs/manual/adding-packages.txt > index cc86529..745e33a 100644 > --- a/docs/manual/adding-packages.txt > +++ b/docs/manual/adding-packages.txt > @@ -22,6 +22,8 @@ include::adding-packages-python.txt[] > > include::adding-packages-luarocks.txt[] > > +include::adding-packages-perl.txt[] > + > include::adding-packages-hooks.txt[] > > include::adding-packages-gettext.txt[] >
diff --git a/docs/manual/adding-packages-perl.txt b/docs/manual/adding-packages-perl.txt new file mode 100644 index 0000000..1e48df9 --- /dev/null +++ b/docs/manual/adding-packages-perl.txt @@ -0,0 +1,110 @@ +// -*- mode:doc; -*- +// vim: set syntax=asciidoc: + +Infrastructure for Perl/CPAN packages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[[perl-package-tutorial]] + ++perl-package+ tutorial +^^^^^^^^^^^^^^^^^^^^^^^ + +First, let's see how to write a +.mk+ file for a Perl/CPAN package, +with an example : + +------------------------ +01: ################################################################################ +02: # +03: # perl-foo-bar +04: # +05: ################################################################################ +06: +07: PERL_FOO_BAR_VERSION = 0.02 +08: PERL_FOO_BAR_SOURCE = Foo-Bar-$(PERL_FOO_BAR_VERSION).tar.gz +09: PERL_FOO_BAR_SITE = $(BR2_CPAN_MIRROR)/authors/id/M/MO/MONGER/ +10: PERL_FOO_BAR_DEPENDENCIES = perl-strictures +11: PERL_FOO_BAR_LICENSE = perl_5 +12: PERL_FOO_BAR_LICENSE_FILES = LICENSE +13: +14: $(eval $(perl-package)) +------------------------ + +On line 7, we declare the version of the package. + +On line 8 and 9, we declare the name of the tarball and the location +of the tarball on a CPAN server. Buildroot will automatically download +the tarball from this location. + +On line 10, we declare our dependencies, so that they are built +before the build process of our package starts. + +On line 11 and 12, we give licensing details about the package (its +license on line 11, and the file containing the license text on line +12). + +Finally, on line 14, we invoke the +perl-package+ macro that +generates all the Makefile rules that actually allow the package to be +built. + +Most of these data could be retrieved from https://metacpan.org/. +So, this file and the Config.in could be generated by running +the script +supports/scripts/scancpan Foo-Bar+ in the +TOPDIR+ directory +(or in the +BR2_EXTERNAL+ directory). +This script recursively creates packages for all required Perl/CPAN +dependencies. + +[[perl-package-reference]] + ++perl-package+ reference +^^^^^^^^^^^^^^^^^^^^^^^^ + +As a policy, packages that provide Perl/CPAN modules should all be +named +perl-<something>+ in Buildroot. + +This infrastructure handles various Perl build systems : ++ExtUtils-MakeMaker+, +Module-Build+ and +Module-Build-Tiny+. ++Build.PL+ is always prefered when a package provides a +Makefile.PL+ +and a +Build.PL+. + +The main macro of the Perl/CPAN package infrastructure is ++perl-package+. It is similar to the +generic-package+ macro. The ability to +have target and host packages is also available, with the ++host-perl-package+ macro. + +Just like the generic infrastructure, the Perl/CPAN infrastructure +works by defining a number of variables before calling the ++perl-package+ macro. + +First, all the package metadata information variables that exist in the +generic infrastructure also exist in the Perl/CPAN infrastructure: ++PERL_FOO_VERSION+, +PERL_FOO_SOURCE+, ++PERL_FOO_PATCH+, +PERL_FOO_SITE+, ++PERL_FOO_SUBDIR+, +PERL_FOO_DEPENDENCIES+, ++PERL_FOO_INSTALL_TARGET+. + +Note that: + + * Setting +PERL_FOO_INSTALL_STAGING+ to +YES+ has no effect (unless + a +PERL_FOO_INSTALL_STAGING_CMDS+ variable is defined), since + Perl modules generally don't need to be installed to the + +staging+ directory. + +A few additional variables, specific to the Perl/CPAN infrastructure, +can also be defined. Many of them are only useful in very specific +cases, typical packages will therefore only use a few of them. + +* +PERL_FOO_CONF_OPT+, to specify additional configure + options to pass to the +perl Makefile.PL+ or +perl Build.PL+. + By default, empty. + +* +PERL_FOO_BUILD_OPT+, to specify additional options to + pass to +make pure_all+ or +perl Build build+ in the build step. + By default, empty. + +* +PERL_FOO_INSTALL_TARGET_OPT+, to specify additional options to + pass to +make pure_install+ or +perl Build install+ in the install step. + By default, empty. + +* +HOST_PERL_FOO_INSTALL_OPT+, to specify additional options to + pass to +make pure_install+ or +perl Build install+ in the install step. + By default, empty. diff --git a/docs/manual/adding-packages.txt b/docs/manual/adding-packages.txt index cc86529..745e33a 100644 --- a/docs/manual/adding-packages.txt +++ b/docs/manual/adding-packages.txt @@ -22,6 +22,8 @@ include::adding-packages-python.txt[] include::adding-packages-luarocks.txt[] +include::adding-packages-perl.txt[] + include::adding-packages-hooks.txt[] include::adding-packages-gettext.txt[]
Signed-off-by: Francois Perrad <francois.perrad@gadz.org> --- docs/manual/adding-packages-perl.txt | 110 ++++++++++++++++++++++++++++++++++ docs/manual/adding-packages.txt | 2 + 2 files changed, 112 insertions(+) create mode 100644 docs/manual/adding-packages-perl.txt