summaryrefslogtreecommitdiff
path: root/pod/perlhack.pod
Commit message (Collapse)AuthorAgeFilesLines
...
* tweak perlhack and update known POD issuesDavid Golden2011-06-201-6/+6
|
* Improve tracking of cpan-upstream overridesDavid Golden2011-06-201-7/+12
| | | | | | | We have the CUSTOMIZED field in Maintainers.pl for indicating where we expect blead to differ from a CPAN tarball. This commit documents that in perlhack and makes core-cpan-diff more aggressive about checking it and reporting about it.
* perlhack.pod: invoke git-format-patch with --attachJim Cromie2011-06-011-3/+4
| | | | | | | | | | | As George Greer noted on p5p, --attach causes the message to be written using MIME-attach syntax, so when perlbug sends it, rt.perl.org detaches the file and adds it to the ticket. While tradtional inline patches appear to survive without whitespace mangling, attachments are more in keeping with RTs design and use. Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
* perlhack.pod: fix perlbug invocationJim Cromie (via RT)2011-05-311-1/+1
| | | | | | | | | | | | | | In perlhack, % perlbug -s "[PATCH] $(git log -1 --format=%s HEAD)" -f 0001-*.patch is incomplete; --format=%s needs a proper value. Use --oneline instead, as it also --abbrev(iates) sha1 $ git log --oneline -1 c8dfc96 regexp.h: repair linux perf compilation Note that HEAD is optional, but just as clear as <branch-name>.
* Docs: perlhack: Use correct shell code and better git/shell constructsMichael Witten2011-05-191-2/+2
| | | | | | | | The example commands for using `git format-patch' and `perlbug' have been streamlined, and (most importantly) single quotes have been replaced with double quotes for constructing the argument to `-s'. Signed-off-by: Michael Witten <mfwitten@gmail.com>
* perlhack: Fix broken linkKarl Williamson2011-05-181-1/+1
|
* Consistent shell prompt character in perlhack.podRichard Möhn2011-03-241-7/+7
| | | | | | | In some parts of pod/perlhack.pod the shell prompt had been indicated by '$', in others by '%'. I made all of them to '%', as '%' is predominant in this file. However, a quick grep through the files in pod/ showed a draw.
* Fix paragraph confusion in pod/perlhack.podRichard Möhn2011-03-241-3/+4
| | | | | | | | | | | | | | | | As far as I understand the diffs, this problem occured first with commit a75f557cc482d1753211634e8aac8b7572677015: The section about "Parallel tests" had been inserted into the list about "Special Make Test Targets" before the last "=item" of the list, but without an empty line between the two of them. The Great Revision of commit 04c692a854b61dfae1266e29468ce4fb51c80512 turned the "=item" about "Parallel tests" into a "=head2", leaving the "=item" statement without the empty line in its old place. There may have been some more editing in this corner. However, I rearranged the lines, so that the "=item" statement goes with its original list about the make test targets again.
* Fix spelling errors in pod/perlhack.podRichard Möhn2011-03-241-26/+26
|
* multifile patch against blead/pod/*.podTom Christiansen2011-02-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | I mostly fixed spelling mistakes, some of very long standing, but a few files got more attentive word-smithying. I've updated: pod/perl.pod pod/perldelta.pod pod/perl592delta.pod pod/perl5120delta.pod pod/perl51310delta.pod pod/perl5139delta.pod pod/perlfunc.pod pod/perlop.pod pod/perlrebackslash.pod pod/perlrecharclass.pod pod/perlutil.pod pod/perlhack.pod pod/perlintern.pod pod/perlnetware.pod pod/perlpolicy.pod
* Add a section on patch style (unified diff, etc) and how to generate patchesDave Rolsky2011-02-051-0/+29
| | | | Based on a suggestion from H.Merijn Brand
* Major revision of perlhack and perlrepositoryDave Rolsky2011-02-041-2946/+632
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* Fix typos in pod/*Peter J. Acklam) (via RT2011-01-071-1/+1
| | | | | | | # New Ticket Created by (Peter J. Acklam) # Please include the string: [perl #81906] # in the subject line of all future correspondence about this issue. # <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=81906 >
* Fix links (and hence the podchecker test) after cce04bebd8af026c.Nicholas Clark2010-12-271-3/+3
|
* Reorganize perlhack.podDavid Golden2010-12-261-675/+683
| | | | | | | | | | | | | Following on an IRC conversation, I've attempted to reorganize perlhack for greater clarity. I have only cut and paste blocks of text and amended section titles and levels. (I have not addressed any of the numerous factual issues which remain.) The resulting guide should be clearer for those trying to skim the table of contents to understand what is covered in perlhack and whether it is worth an in-depth read. I see this change as the first step towards future improvements.
* Generate perlmain.c using ExtUtils::Miniperl, instead of writemain.SH.Nicholas Clark2010-11-281-1/+1
| | | | | This allows writemain.SH to be removed. This also has the side effect of testing that ExtUtils::Miniperl actually works. :-)
* typos in comments/podFingle Nark2010-11-081-1/+1
|
* Link to perlbug's PODTom Hukins2010-11-051-1/+1
|
* Remove CALL_FPTR and CPERLscope.Ben Morrow2010-08-201-1/+1
| | | | | | | | | | | | | | | | These are left from PERL_OBJECT, which was an implementation of multiplicity using C++ objects. PERL_OBJECT was removed in 5.8, but the macros seem to have been cargo-culted all over the core (including in places where they would have been inappropriate originally). Since they now do exactly nothing, it's cleaner to remove them. I have left the definitions in perl.h, under #ifndef PERL_CORE, since some CPAN XS code uses them (also often incorrectly). I have also left STATIC alone, since it seems potentially more useful and is much more ingrained. The only appearance of these macros this patch doesn't touch is in Devel-PPPort, because that's a CPAN module.
* perlhack: Note existence of t/lib/warningsKarl Williamson2010-08-021-0/+4
| | | | | I didn't know about it, and thus went to unnecessarily effort until this was kindly pointed out to me.
* perlhack: Add -Dusedevel to gcov Configure lineÆvar Arnfjörð Bjarmason) (via RT2010-07-261-1/+2
| | | | | | | | | # New Ticket Created by (Ævar Arnfjörð Bjarmason) # Please include the string: [perl #76710] # in the subject line of all future correspondence about this issue. # <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=76710 > Building blead doesn't work without -Dusedevel most of the time.
* Clarify core module directories for UPSTREAM => undef modulesFlorian Ragwitz2010-07-231-0/+4
|
* perlhack: Add reference to TAP for test protocolKarl Williamson2010-06-071-0/+1
|
* perlhack: fix formatting issuesKarl Williamson2010-06-071-19/+24
| | | | Change some lines so won't overflow 80 column width; make a link.
* Update rsync sources in perlhackH.Merijn Brand2010-05-251-6/+11
|
* * Em dash cleanup in pod/brian d foy2010-01-131-10/+10
| | | | | | | | | | | | | I looked at all the instances of spaces around -- and in most cases converted the sentences to use more appropriate punctuation. In general, the -- in the perl docs seem to be there only to make really complicated and really long sentences. I didn't look at the closed em-dashes. They probably have the same sentence-complexity problem. I left some open em-dashes in place. Those are the ones used in lists.
* PATCH: minor typo cleanup of pod/ directoryTom Christiansen2010-01-051-4/+4
| | | | | | | | | | | | | | These are all in the pod/ directory, and only the first is a code fix. There was also a single lingering ISO 8859-1 encoding that missed the UTF-8 upconvert. The rest are cleanups for typos, some of which seem to have been around for a rather long time: spelling errors, incorrect possessives, and extra, missing, or duplicated words. If you actually read through, I bet you'll realize what sparked this. :) --tom Signed-off-by: Abigail <abigail@abigail.be>
* Update .podsKarl Williamson2009-12-251-1/+1
| | | | Signed-off-by: Abigail <abigail@abigail.be>
* Updated docpointer for illgutsReini Urban2009-12-091-5/+3
|
* Describe how Configure patches should be doneH.Merijn Brand2009-11-061-4/+16
|
* Fix another reference to the now-gone patching.podDave Rolsky2009-10-301-3/+2
|
* Remove obsolete details on how to format a patch. Just point to ↵Dave Rolsky2009-10-301-30/+4
| | | | perlrepository instead.
* CPAN::YACSmoke has been deprecated and minismokebox is a much more robust ↵Chris Williams2009-10-071-2/+2
| | | | CPAN testing framework. Updated the links accordingly.
* Move t/pod/diag.t to t/porting, as it's really a code consistency test.Nicholas Clark2009-10-011-5/+0
| | | | It was the last test in t/pod, which allows us to remove the directory.
* Re: lib, ext, cpan and dist [PATCH] (take 2)Richard Foley2009-10-011-3/+12
| | | | Message-Id: <200910011047.35459.Richard.Foley@rfi.net>
* describe parallel testing in perlhack.podJesse Vincent2009-10-011-0/+17
|
* move regex related tests out of t/op/ into t/re/Yves Orton2009-09-101-0/+5
|
* Improve perlhack instructions about gprofJohn P. Linderman2009-08-261-3/+3
|
* Document what needs to happen when you add a new test directoryJesse Vincent2009-08-031-0/+3
|
* A few docs nits after the few last commitsRafael Garcia-Suarez2009-06-211-11/+11
|
* update PERL_MEM_LOG in perlhack.podJim Cromie2009-06-211-21/+23
|
* point illguts at perl.orgJim Cromie2009-06-211-4/+6
|
* Fix typo in pod/perlhack.podAbigail2009-01-121-1/+1
|
* Update comments and documentation dealing with utfKarl2008-12-261-7/+8
|
* Remove mentions of the old way of rsync'ing the sourceRafael Garcia-Suarez2008-12-261-354/+22
|
* Subject: PATCH 5.10 documentationSteve Peters2008-12-191-3/+58
| | | | | | From: karl williamson <public@khwilliamson.com> Date: Tue, 16 Dec 2008 16:00:34 -0700 Message-ID: <49483312.80804@khwilliamson.com>
* PATCH: Large omnibus patch to clean up the JRRT quotesTom Christiansen2008-11-021-0/+56
| | | | | | Message-ID: <25940.1225611819@chthon> Date: Sun, 02 Nov 2008 01:43:39 -0600 p4raw-id: //depot/perl@34698
* Add SV allocation tracing to -Dm and PERL_MEM_LOGMarcus Holland-Moritz2008-10-241-0/+32
| | | | | Message-ID: <20081022013731.23b5a2e5@r2d2> p4raw-id: //depot/perl@34568
* Re: [PATCH] perlhack.pod update walkthroughLeon Brocard2008-03-261-10/+16
| | | | | | From: "Leon Brocard" <acme@astray.com> Message-ID: <a92222c80803260353k6cae53eieea909aed0a967b5@mail.gmail.com> p4raw-id: //depot/perl@33570
* Add mro tests to minitestRafael Garcia-Suarez2007-12-121-1/+1
| | | p4raw-id: //depot/perl@32616
View Lorry Controller Status