summaryrefslogtreecommitdiff
path: root/PACKAGING
diff options
context:
space:
mode:
authorDominic Hargreaves <dom@earth.li>2017-10-14 16:27:53 +0200
committerDominic Hargreaves <dom@earth.li>2017-10-24 12:28:28 +0100
commitba6733216202523a95b0b7ee2e534b8e30b6d7df (patch)
treec1f166ed3c8b63e167b8c1ce75171c6ac502e66d /PACKAGING
parenta17768d7c7b82c136fbeacd85db3451973a8007a (diff)
downloadperl-ba6733216202523a95b0b7ee2e534b8e30b6d7df.tar.gz
Skip various tests if PERL_BUILD_PACKAGING is set
These are tests which tend not to be useful for downstream packagers t/porting/customized.t change originally from Todd Rinaldo
Diffstat (limited to 'PACKAGING')
-rw-r--r--PACKAGING30
1 files changed, 30 insertions, 0 deletions
diff --git a/PACKAGING b/PACKAGING
new file mode 100644
index 0000000000..0c69b87ba6
--- /dev/null
+++ b/PACKAGING
@@ -0,0 +1,30 @@
+If you read this file _as_is_, just ignore the funny characters you
+see. It is written in the POD format (see pod/perlpod.pod) which is
+specifically designed to be readable as is.
+
+=head1 NAME
+
+PACKAGING - notes and best practice for packaging perl 5
+
+=head1 SYNOPSIS
+
+This document is aimed at anyone who is producing their own version of
+perl for distribution to other users. It is intended as a collection
+of useful tips, advice and best practice, rather than being a complete
+packaging manual. The starting point for installing perl remains
+F<INSTALL>.
+
+=head1 Customizing test running
+
+A small number of porting tests (those in t/porting) are not well suited
+to typical distribution packaging scenarios. For example, they assume
+they are working in a git clone of the upstream Perl repository, or
+enforce rules which are not relevant to downstream packagers. These can
+be skipped by setting the environment variable PERL_BUILD_PACKAGING.
+A complete list of tests which this applied to can be found by searching
+the codebase for this string.
+
+An alternative strategy would be to skip all porting tests, but many of
+them are useful if additional patches might be applied.
+
+=cut