PACKAGING

   1 # vim: syntax=pod
   2
   3 If you read this file _as_is_, just ignore the funny characters you
   4 see.  It is written in the POD format (see pod/perlpod.pod) which is
   5 specifically designed to be readable as is.
   6
   7 =head1 NAME
   8
   9 PACKAGING - notes and best practice for packaging perl 5
  10
  11 =head1 SYNOPSIS
  12
  13 This document is aimed at anyone who is producing their own version of
  14 perl for distribution to other users. It is intended as a collection
  15 of useful tips, advice and best practice, rather than being a complete
  16 packaging manual. The starting point for installing perl remains
  17 F<INSTALL>.
  18
  19 =head1 Customizing test running
  20
  21 A small number of porting tests (those in t/porting) are not well suited
  22 to typical distribution packaging scenarios. For example, they assume
  23 they are working in a git clone of the upstream Perl repository, or
  24 enforce rules which are not relevant to downstream packagers. These can
  25 be skipped by setting the environment variable PERL_BUILD_PACKAGING.
  26 A complete list of tests which this applied to can be found by searching
  27 the codebase for this string.
  28
  29 An alternative strategy would be to skip all porting tests, but many of
  30 them are useful if additional patches might be applied.
  31
  32 =head1 Customizing patchlevel to advertise your local patches
  33
  34 You can advertise your custom local patches by using patchlevel.h as a
  35 standalone Perl script.
  36
  37 =head2 Sample usage:
  38
  39                 perl -x patchlevel.h "This is a custom patch"
  40
  41 =head1 Disabling known flapping tests
  42
  43 Some tests could fail under heavy load, whereas in most cases
  44 they would simply succeed. Usually, continuous integration systems
  45 will at one point or the other reach that problem.
  46
  47 To disable these known tests, please set the environment
  48 variable CI to true.
  49
  50         CI=true
  51
  52 =cut