summaryrefslogtreecommitdiff
path: root/MANIFEST
diff options
context:
space:
mode:
authorDave Rolsky <autarch@urth.org>2011-01-31 16:15:24 -0600
committerJesse Vincent <jesse@bestpractical.com>2011-02-04 12:12:28 -0500
commit04c692a854b61dfae1266e29468ce4fb51c80512 (patch)
tree3129ae7f8c1c26d4f8dd6c2a4165e9abdbcd2097 /MANIFEST
parent3df2ec53a8bebf2834a6148ee2f3453fdc73fd66 (diff)
downloadperl-04c692a854b61dfae1266e29468ce4fb51c80512.tar.gz
Major revision of perlhack and perlrepository
The existing perlhack is huge and takes a long time to get to key information like "how to submit a patch". It also contains a massive amount of (very useful) detail on the Perl interpreter, debugging, portability issues, and so on. Some parts of perlhack are just obsolete. For example, Larry really isn't deeply involved on p5p any more. Meanwhile, perlrepository _also_ contains a lot of useful information on patching Perl, as well as a small git tutorial focused on working with the Perl repository. Taken together, the two documents overlap and conflict with each other. This commit does the following: == Reconcile conflicts and overlaps, remove obsolete information I've separated out distinct pieces of information and organized them into individual pod files. More on that below. I've also removed anything that was obviously out of date. == Make it easier for casual contributors to contribute. The perlhack document now gets to "how to make a patch" very quickly. My assumption is that most contributors to Perl are doing something small, like fixing pod, adding a test, etc. The documentation aimed at people doing more extensive hacking is still there, but it's been moved so that it comes at the end of the document or has been moved to another document. I've made an effort to cross-reference the various documents so that nothing gets lost. == Get to the point The perlhack document had a lot of discussion of general Perl culture. I've trimmed a lot of this and moved some of it so it comes later. == Per-file summary === perlrepository.pod This is gone. Some of its content is now in perlhack. This includes the bits on writing good commit messages, how (and where) to submit a patch, etc. The rest is now called perlgit, and is _only_ a git how-to. === perlhack.pod This has been cut down quite a bit. I changed the opening so it starts with a quick guide to submitting small patches. The document covers bug reporting, the p5p list, a quick how-to on getting the source (including git, gitweb, and rsync), and a lot of general information on patching perl and running tests. Much of this material was already present, but I've done a fair amount of editing for modernization and clarity. Most of the information specific to C-level hacking has been moved to other documents. === perlsource.pod This is a guide to the Perl source tree. Most of the content was extracted from perlhack. I've edited existing content and added details on some parts of the tree that weren't covered. === perlinterp.pod This is a tour of the Perl interpreter source and a walkthrough of how it works that originally lived in perlhack. This has received very little editing. === perlhacktut.pod This is a walkthrough of creating a sample patch to the C core code that originally lived in perlhack. This has received very little editing. === perlhacktips.pod The perlhack document contained a lot of useful information on low-level hacking details like debugging, compilation issues, portability, etc. This has received very little editing. I did remove some bits on ancient stuff related to Tru64 and IRIX.
Diffstat (limited to 'MANIFEST')
-rw-r--r--MANIFEST6
1 files changed, 5 insertions, 1 deletions
diff --git a/MANIFEST b/MANIFEST
index 6831b0dc37..b7c88f8717 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -4320,11 +4320,15 @@ pod/perlfilter.pod Perl source filters
pod/perlfork.pod Perl fork() information
pod/perlform.pod Perl formats
pod/perlfunc.pod Perl built-in functions
+pod/perlgit.pod Using git with the Perl repository
pod/perlglossary.pod Perl Glossary
pod/perlgpl.pod GNU General Public License
pod/perlguts.pod Perl internal functions for those doing extensions
pod/perlhack.pod Perl hackers guide
+pod/perlhacktips.pod Tips for Perl core C code hacking
+pod/perlhacktut.pod Walk through the creation of a simple C code patch
pod/perlhist.pod Perl history records
+pod/perlinterp.pod Overview of the Perl intepreter source and how it works
pod/perlintro.pod Perl introduction for beginners
pod/perliol.pod C API for Perl's implementation of IO in Layers
pod/perlipc.pod Perl interprocess communication
@@ -4357,12 +4361,12 @@ pod/perlref.pod Perl references, the rest of the story
pod/perlreftut.pod Perl references short introduction
pod/perlreguts.pod Perl regular expression engine internals
pod/perlre.pod Perl regular expressions, the rest of the story
-pod/perlrepository.pod Perl source repository
pod/perlrequick.pod Perl regular expressions quick start
pod/perlreref.pod Perl regular expressions quick reference
pod/perlretut.pod Perl regular expressions tutorial
pod/perlrun.pod Perl execution and options
pod/perlsec.pod Perl security
+pod/perlsource.pod Guide to the Perl source tree
pod/perlstyle.pod Perl style guide
pod/perlsub.pod Perl subroutines
pod/perlsyn.pod Perl syntax