summaryrefslogtreecommitdiff
path: root/pod/perlrepository.pod
Commit message (Collapse)AuthorAgeFilesLines
* Restore perlrepository.pod in stub formSmylers2013-09-031-0/+18
| | | | | | | | | | | | Give Perl doc sites a sane ‘latest’ version to display, directing readers to current information, rather than showing the Perl 5.12 version in perpetuity. And help anybody typing man perlrepository find where the docs have moved to. Suggested by Father Chrysostomos in: http://www.nntp.perl.org/group/perl.perl5.porters/2013/09/msg207079.html
* Major revision of perlhack and perlrepositoryDave Rolsky2011-02-041-1003/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* [perl #82702] Fix commit message internal link.Michael Stevens2011-01-241-1/+1
|
* perlrepository: Add example of why tests need runningKarl Williamson2011-01-051-1/+7
|
* Document 'test_porting' and start a section on how committing to bleadJesse Vincent2011-01-011-0/+32
|
* [perl #81218] Note that perlbug to p5p is subject to moderationDavid Leadbeater2010-12-261-3/+3
|
* 'make regen' really shouldn't be specialJim Cromie2010-09-161-11/+0
| | | | | Revert 'make regen' special case advice of 94e892a68016a417b1b324213d39309b8b744d0e, leave the minor whitespace cleanup.
* Fix some more typos and bad wordingFlorian Ragwitz2010-09-071-6/+6
| | | | Pointed out by pjcj++ and, again, ilmari++
* Try to encourage sending perldelta entriesFlorian Ragwitz2010-09-061-0/+45
|
* perlrepository.pod: Elaborate -a, -mKarl Williamson2010-08-091-0/+12
|
* Podtidy perlrepository.podLeon Brocard2010-08-031-38/+38
|
* Fix POD formatting in perlrepository.podFlorian Ragwitz2010-07-231-1/+0
| | | | | =for is just for one paragraph, not until the next command or anything like that.
* Clarify that mail to perlbug also goes to p5pÆvar Arnfjörð Bjarmason2010-05-091-4/+7
| | | | | | | | | The wording added in 64a8e22bd3 didn't clarify that mail to perlbug is also forwarded to perl5-porters. Make this section clearer so that it now explains that perlbug is just perl5-porters + RT tracking. See the discussion after Craig A. Berry's comment in RT #73914 for reference.
* Add =encoding utf8 to all core non-ASCII POD files + test scriptÆvar Arnfjörð Bjarmason2010-05-081-0/+2
| | | | | | | | | | | | | It's now possible to run: perl Porting/checkpodencoding.pl To check if the core contains any naughty POD that uses non-ASCII without declaring an encoding. With this patch all the POD in core (except POD tests we're ignoring) has a correct =encoding directive. The script also flags problems in lib/* and cpan/* which aren't being fixed as part of this commit.
* Please don't use any of your git aliases in perlrepository.podVincent Pit2010-05-031-2/+2
|
* Pod formatting nitsRafael Garcia-Suarez2010-04-231-5/+8
|
* Don't ask the porters to fetch commits from a private URLÆvar Arnfjörð Bjarmason2010-04-211-1/+1
| | | | | | git@github.com:USERNAME/perl.git is only accessible to USERNAME (or collaborators), git://github.com/USERNAME/perl.git is available to everyone.
* Consistently use a topic branch in the GitHub examplesÆvar Arnfjörð Bjarmason2010-04-211-6/+6
| | | | | | | | Also use an example of an actual topic branch commit of that got into Perl (<51dd1af81002161108rff277d7r6d0ccee6b45982a0@mail.gmail.com>). Previously the docs referenced 3adac458cb which doesn't exist in the repository, 0c24b290ae does.
* Recommend git format-patch -M (detect renames) and origin..Ævar Arnfjörð Bjarmason2010-04-211-1/+1
| | | | | The latter doesn't strictly matter, but it's easier to see what's going on with those two dots.
* Mention L<perlpolicy> and link to it in SEE ALSOÆvar Arnfjörð Bjarmason2010-04-201-3/+10
|
* Only all-upper case "special" POD sectionsÆvar Arnfjörð Bjarmason2010-04-201-16/+16
| | | | | | | "GETTING ACCESS TO THE REPOSITORY" is a bit too loud compared to "Getting access to the repository". The POD standard itself doesn't have anything to say about this, but most of our long =head1 sections in pod/*.pod don't use all-caps.
* Commit messages should start with a ~50 char summaryÆvar Arnfjörð Bjarmason2010-04-201-2/+10
| | | | | | | The first sentence is stolen from Git's own Documentation/SubmittingPatches. We have a lot of commit messages that overflow `git log --pretty=oneline', but it wouldn't hurt if we change that sooner rather than later.
* POD: Use F<> for F<utils/perldoc> and F<utils/perldoc.PL>Ævar Arnfjörð Bjarmason2010-04-201-1/+1
|
* Don't tell the reader to `git checkout origin/*'Ævar Arnfjörð Bjarmason2010-04-201-4/+0
| | | | | | | | | This results in a branchless checkout (detached HEAD). Making changes like this is a valid way to use Git, but IMO not something we should be recommending. Branches are cheap and it's harder to lose your commits if they're on a named branch than on a detached HEAD.
* GitHub's mirror is now at mirrors/perl, not github/perlÆvar Arnfjörð Bjarmason2010-04-201-2/+2
|
* Point submitters to perlbug@perl.org, not perl5-porters@perl.orgÆvar Arnfjörð Bjarmason2010-04-151-8/+15
| | | | | We usually want patches in RT. Patches should only go to perl5-porters if they're intended purely for discussion.
* Before 96a8704c makedepend.SH used shell quote syntax that modernÆvar Arnfjörð Bjarmason2010-04-131-0/+9
| | | | | shells barf on. Document how to work around this in the example bisect script.
* When your bisect starts to go into perl-5.9.* territory `make -j4'Ævar Arnfjörð Bjarmason2010-04-131-1/+1
| | | | | fails on Config.pm due to some race condition. This'll turn what would otherwise be a bad/good report into skip.
* When using a GitHub fork advice the use of Perl's Git, not GitHub's mirrorÆvar Arnfjörð Bjarmason2010-03-271-1/+1
| | | | | This bit me when `git pull upstream blead' didn't pull commits I knew had been commited, turned out GitHub's mirror was out of date.
* give two simpler recipes for creating remote branchesAristotle Pagaltzis2010-03-241-15/+13
|
* describe how to create a remote topic branchDavid Mitchell2010-03-241-0/+16
|
* fetching from e.g. github requires a repo nameDavid Mitchell2010-03-021-1/+1
|
* Mention why it's a good idea to use topic branches for everythingÆvar Arnfjörð Bjarmason2010-02-161-0/+8
| | | | | | | Most of this is derived from Dan Golden's E-Mail to me on perl5-porters with the subject "[PATCH] Add comments to gv.c about variable implementation" where I'd submitted a patch without using a topic branch.
* Adjusted the git config user.name/user.email example for what 99% of users ↵Ævar Arnfjörð Bjarmason2010-02-161-3/+9
| | | | | | | | | | | | | would like to do Almost nobody wants to set user.name/user.email on a per-repository basis as the previous example suggested. I put in a new example that shows how to use C<git config --global> along with an example of how to set user.email just for F<perl-git> I replaced Leon Brocard's name with mine because he didn't fit into the multiple E-Mail address example and I couldn't think of another example.
* Prefix commands universally with "%". Most of the POD used that convention ↵Ævar Arnfjörð Bjarmason2010-02-161-6/+6
| | | | but a few cases didn't
* Don't recommend that people manually fiddle with their F<.git/config>, ↵Ævar Arnfjörð Bjarmason2010-02-161-9/+4
| | | | instead they should edit it with L<git-config(1)>
* Note that checking out from git via http:// is at least 4x slower than git://Ævar Arnfjörð Bjarmason2010-02-161-1/+1
| | | | | | Tested on a 10 MiB/s connection in London, although this is also IO/CPU bound since Git needs to resolve deltas and check out after the repository has made it across the wire.
* Fixed an editing error in perldoc about commit messages.Jesse Vincent2010-01-181-4/+4
| | | | (Thanks to Aristotle Pagaltzis)
* Minor updates to the git tutorial and our commit message policies.Jesse Vincent2010-01-181-2/+12
|
* * Em dash cleanup in pod/brian d foy2010-01-131-1/+1
| | | | | | | | | | | | | 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.
* advice regarding make regen changesJim Cromie2010-01-031-4/+13
|
* s/text message/text editor/ in the last change to perlrepository.podVincent Pit2009-12-301-1/+1
| | | | Spotted by David E. Wheeler.
* Update perlrepository.pod with new guidelines on commit messages and patches.Jesse Vincent2009-12-301-16/+69
| | | | | | | | Karl Williamson pointed out to me that our existing guidelines on commit messages in 'perlrepository.pod' were somewhat less than ideal. This commit improves our documentation for commit messages, though it may want cleanup or further improvement.
* Speed-up notice for bisects (skip Encode)H.Merijn Brand2009-12-201-0/+2
|
* More info about camel in perlrepository.podDennis Kaarsemaker2009-11-231-9/+18
| | | | Signed-off-by: H.Merijn Brand <h.m.brand@xs4all.nl>
* {camel,dromedary}.booking.com names are gone, so update them to ↵Vincent Pit2009-11-181-46/+50
| | | | | | {,users.}per5.git.perl.org And run podtidy.
* refine the documentation for deleting branches and altering historyYves Orton2009-10-261-19/+43
|
* Hashed out a prose description of the (largely existing) branching and topic ↵Jesse Vincent2009-10-261-0/+38
| | | | | | | branch policy. Wrote down the existing "no, don't mess with blead's history, bozo" setup
* Cap the exit code of the bisecting scriptVincent Pit2009-10-231-0/+1
| | | | | Segfaults cause $? to be set to 139 on my machine, which stops the bisect process.
* "-x ./foo" isn't a shell command, but "[ -x ./foo ]" isVincent Pit2009-10-231-1/+1
|
View Lorry Controller Status