summaryrefslogtreecommitdiff
path: root/pod/perlhack.pod
Commit message (Collapse)AuthorAgeFilesLines
* t/harness - rework App::Prove::State setup to not warn and use customizable ↵Yves Orton2023-03-281-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | state file Currently we only store state if we are running parallel tests, so if you run the tests in series we do not store data on how long they took, and we can't use that information in a follow up parallel test run. We also do not allow the state file to be customized to be outside of the repo, so git clean -dfx wipes it. This means you can't keep your test data over time, which can be a bit annoying. We also currently construct the state object twice during setup, resulting in two (useless) warnings when the state file is missing, which also doubles the time to set up the tests because the yaml file gets read twice, and not very efficiently either. This patch changes the logic so that we initialize the state object only once during startup, and we use the state file if we are going to run tests, parallel or not, provided the user does not explicitly disable it (see below). The order that tests are run is affected only when the tests are run in parallel. It also allows the user to specify where the state file should live, with the $ENV{PERL_TEST_STATE_FILE} environment variable, which can be set to 0 or the empty string to disable use of the state file if needed. We also take care to silence the warning about an empty state file, except in the case where the user has overriden the file name with the $ENV{PERL_TEST_STATE_FILE}. Lastly this patch disables loading the state data /at all/, when the dump_tests option is invoked. There is no need nor point to load the state data when we are simply going to dump out the list of tests we will run.
* pod/perlhacks.pod - document TEST_ARGS and make win32 perl use it tooYves Orton2022-11-081-0/+16
| | | | | | | Win32 has had TEST_SWITCHES and TEST_FILES for ages. Unix has TEST_ARGS. This extends Win32 to support TEST_ARGS as well. I havent made the contrary change to the unix code, anyone using TEST_SWITCHES is already using it on Win32.
* perlhack: Fix some pod markup, overlong verbatimKarl Williamson2022-05-061-7/+8
| | | | | | | the F<> marker shouldn't need to be told whether or not to use "" to demarcate its argument. It should know what to do. Also fix some overlong verbatim lines
* perlhack: make language about 79-col lines laxerRicardo Signes2022-03-071-1/+5
|
* Unencrypted git protocol no longer supported by github.comJames E Keenan2021-11-091-1/+1
| | | | | | Reference: https://github.blog/2021-09-01-improving-git-protocol-security-github/ For: https://github.com/Perl/perl5/pull/19220
* rsync perl5.git.perl.org has gone awayNicholas Clark2021-10-061-18/+0
| | | | Delete the section from perlhack.pod that mentioned it.
* Update search.cpan.org URLsJames E Keenan2021-02-191-1/+1
| | | | | | | | | | | | | | search.cpan.org has (sadly) been gone for several years now. This patch updates the remaining important instances of that URL found in the parts of the core distribution under the control of Perl 5 Porters, i.e., excluding the cpan/ directory. The patch does not attempt to update URLs in "historical" data, e.g., older perldeltas. Nor does it attempt to deal with results produced by Porting/checkURL.pl. Following discussion: Abandon changes to 'if' and 'PathTools' META.json files.
* pod: update a few documents for perlgov changesRicardo Signes2020-12-281-3/+3
|
* Document PERL_TEST_HARNESS_ASAPKarl Williamson2020-12-021-6/+21
| | | | | which can increase the CPU occupancy when running the test suite in parallel on a many-core system, resulting in earlier completion.
* Replace ssh with https (#18229)apparluk2020-10-131-0/+7
| | | | | | | | | | | * use https in perlhack.pod * https and ssh in perlhack.pod * closing angle bracket * links * author
* Remove PERL_GLOBAL_STRUCTDagfinn Ilmari Mannsåker2020-07-201-1/+1
| | | | | | | | This was originally added for MinGW, which no longer needs it, and only still used by Symbian, which is now removed. This also leaves perlapi.[ch] empty, but we keep the header for CPAN backwards compatibility.
* Fix a bunch of repeated-word typosDagfinn Ilmari Mannsåker2020-05-221-1/+1
| | | | | Mostly in comments and docs, but some in diagnostic messages and one case of 'or die die'.
* Document purpose of miniperlTony Cook2020-02-091-0/+6
| | | | | For: https://github.com/Perl/perl5/issues/16158 (formerly RT 132137).
* Clarify guidance for usage of Test::More in testsJames E Keenan2020-02-041-5/+9
| | | | | | | | | | | | | | | | | As reported by Smylers in RT 119619 (now GH 13231), the guidance provided in 'perlhack' for usage of Test::More is misleading. In practice, we do not use Test::More in test files in the subdirectories underneath 't/'. In these directories we test Perl 5's "pre-modular" functionality -- functionality which does not depend on our having demonstrated that we can load code via 'use MODULE'. Usage of 'use MODULE' in 't/*/*.t' files has been largely prohibited by a unit test in t/porting/bootstrap.t. This patch clarifies that guidance. POD correction per Tony Cook For: https://github.com/Perl/perl5/issues/13231
* Change various search.cpan.org references to metacpan.org and www.cpan.orgDan Book2020-01-221-4/+4
|
* Update documentation, readmes, comments, and utilities to reference the ↵Dan Book2019-12-221-6/+3
| | | | | | GitHub issue tracker The perlbug utility and perlbug@perl.org should no longer be used to submit bug reports or patches.
* Convert issue links from rt.perl.org to GitHubDan Book2019-11-261-2/+2
|
* Update perlgit and perlhack to reference GitHub pull request workflowDan Book2019-10-241-35/+29
|
* Update documentation, comments, metadata to reference GitHub as canonical ↵Dan Book2019-10-201-8/+7
| | | | | | | | | | | | | | | | repository (#1186) * Update repository and bugtracker URLs to GitHub in makemeta regen META files * Update POD and comments to reference GitHub as canonical repository * Update Porting/corelist.pl to recognize GitHub issue tracker * remove "A note on camel and dromedary" * Remove redundant 'Committing your changes' section
* Switch from http://search.cpan.org/ as entry URL to https://metacpan.org/Max Maischein2019-10-131-1/+1
|
* Move more URLs from http:// to https://Max Maischein2019-10-111-14/+14
|
* Replace a few http urls with httpsKang-min Liu2019-09-081-1/+1
| | | | A few link labels are also updated.
* Revise inclusion of name and email in Git historyv5.28.0Sawyer X2018-06-221-1/+2
|
* trailing spaces drive me nutsSawyer X2018-06-221-1/+1
|
* Clarify your name and email *will* appear in AUTHORS unless asked:Sawyer X2018-06-201-0/+9
| | | | | | | | Neil Bowers and Andreas Koenig spotted that, based on GDPR, we should clarify to people that their name and email will appear in AUTHORS when submitting a patch and that it can be removed when asked. Neil contributed the phrasing.
* RT#132520: mention it's OK to attach a patch to an RT ticketMarco Fontani2017-11-301-0/+3
| | | | | | | | | ... as was the case of my first patch to perl: I tried to find my use case in perlhack.pod, failed, and "hoped for the best". With this, perlhack makes clearer that attaching a patch to an already existing RT ticket is a perfectly valid and accepted use-case for getting patches into perl - same as using perlbug.
* When and how to use Devel::PatchPerl to repair older builds.James E Keenan2017-06-011-0/+49
| | | | Following recommendation by Matthew Horsfall.
* pods: Add L<> for links missing them; a couple nitsKarl Williamson2017-04-051-3/+3
|
* Added some discussion of tabs & spaces in the source codeAndy Lester2016-10-311-2/+7
|
* fix more file pathsLukas Mai2016-01-101-1/+1
|
* fix list rendering in perlhackKaren Etheridge2015-09-091-2/+2
| | | | | | | | | | | | | | | At http://perldoc.perl.org/perlhack.html#TESTING, this was rendering as: 1 ) These select Unicode rules.... 2 ) If you use the form... For: RT #126021
* perlhack: Nits and update for v5.22Karl Williamson2015-04-181-6/+11
|
* Add text about EBCDIC to pods: perlhack* perlportKarl Williamson2015-01-141-3/+51
|
* add Porting/bench.plDavid Mitchell2014-11-291-0/+21
| | | | | | | | | | | | | | | | | | | This tool runs code snippets found in t/perf/benchmarks (or similar) under cachegrind, in order to calculate how many instruction reads, data writes, branches, cache misses, etc. that one execution of the snippet uses. It will run them against two or more perl executables and show how much each test has gotten better or worse. It is modelled on the perlbench tool, but since it measures instruction reads etc., rather than timings, it is much more precise and reproducible. It is also considerably faster, and is capable or running tests in parallel. Rather than displaying a single relative percentage per test/perl combination, it displays values for 13 different measurements, such as instruction reads, conditional branch misses etc. This commit also changes the format of t/perf/benchmarks slightly; it becomes an AoH rather than a HoH (to allow checking for duplicate keys), and the test names themselves become a :: hierarchy.
* Update Perl 5 Porter list archives.James E Keenan2014-10-171-2/+1
| | | | For: RT # 122996
* Mention perlbug -p in perlhack.Craig A. Berry2014-01-171-11/+9
| | | | | Using git's --attach with perlbug -f actually mangled the patches, making them harder to apply, but now we have a better way to do it.
* Correct URL for github.com mirror of Perl 5 repository.Martin McGrath2013-12-191-1/+1
| | | | | | Add Martin McGrath to AUTHORS. For: RT #120819
* perlhack.pod: consistent spaces after dotsFather Chrysostomos2013-11-011-2/+2
|
* perlhack: Make MAINTENANCE BRANCHES a linkFather Chrysostomos2013-09-171-1/+1
|
* add reference to maintenance branches in perlpolicyChristian Millour2013-09-171-1/+2
|
* Multiple commits in 1 attachment in Patch GuideSmylers2013-09-051-19/+8
| | | | | | | | | | | In the Super Quick Patch Guide, if a change involves multiple commits, put them all in a single perlbug attachment. Father Chrysostomos says it's easier like this, in a comment on RT #119599. It simplifies the instructions, and avoiding the need to mention mail clients.
* When sending an email manually so it can have multiple patches, point outSmylers2013-09-051-1/+4
| | | | | | | | | | | | | | | | that Mutt can construct the email for you. Obviously this isn't as generally relevant as the rest of the Guide, since patchers will use many different mail clients. But it's a significant boon for those who do use Mutt, and a very short addition to the Guide. Mutt is singled out simply because it has this functionality; I suspect that most other widely used mail clients don't. Committer: Removed trailing whitespace. Applied patch manually because other lines in the file had been rebroken and patch no longer applied cleanly. For: RT #119599
* Multiple commits in Super Quick Patch GuideSmylers2013-09-051-0/+17
| | | | | | | | | | | | How to use perlbug when a change is a series of commits, not a single commit. This is the advice RJBS gave me over IRC. Including it in the guide should avoid him having to repeat the advice to others. Committer: Added single quotes around one keyboard command. For: RT #119599
* Resetting a check out in Super Quick Patch GuideSmylers2013-09-051-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | Add advice so that somebody wishing to submit a second patch doesn't need to throw away their perl check-out and start again. Not knowing the 'git clean' step caught me out, and meant perl wouldn't build for me. Nicholas helped me out. Adding this to the guide will hopefully save Nicholas from having to repeat that for others (especially since others may not be fortunate enough to have Nicholas handily seated next to them at the point they encounter it). (The non-building was because some things in the repository had been re-arranged since my previous patch (several months earlier), and the latest build was getting confused by some files left over from a pre-re-arragned build.) The 'git clean' step will also remove the first 0001-*.patch file, avoiding the problem of there being two files matching that glob when attaching the second patch. Committer: Removed trailing whitespace. For: RT #119599
* Suggest reading blead's Super Quick Patch GuideSmylers2013-09-051-0/+7
| | | | | | | | | | | | | | | The Super Quick Patch Guide has been improved several times. Suggest that a patcher looks at the latest version in the checkout of blead they've just made, in case that's been improved since whichever released version they were reading. This has caught me out before: I've done something sub-optimal (for me or those reviewing my patches) by diligently following out-of-date instructions. Remove trailing whitespace. For: RT #119599
* perlbug command wrapped to fit in 79 columnsSmylers2013-09-051-1/+2
| | | | | | | | | | | | To pass t/porting/podcheck.t --pedantic The line-break is inside a $(...), so the lines can be copied-and-pasted as they are, complete with line-break and extra spaces, and still give the same output. Remove trailing whitespace. For: RT #119599
* Have perlbug report version being patchedSmylers2013-09-051-1/+1
| | | | | | | | | In the Super Quick Patch Guide, run the perlbug and perl from the working copy that the patch is against, so the bug report contains relevant version and configuration data, rather than that of whichever system perl the reporter happens to have installed. For: RT #119599
* Consistent indent on shell commandsSmylers2013-09-051-9/+9
| | | | | | | | | Most verbatim lines with shell commands had 2 spaces before the % prompt. A few had 1 or 4 spaces. Make them all 2. Remove trailing whitespace. For: RT #119599
* perlhack.pod tidiedSmylers2013-09-051-43/+44
| | | | | | | | | In accordance with the comment at the top of the file, before I make other changes to it. Remove trailing whitespace. For: RT #119599
* Consistent spaces after dots in perlhack.podFather Chrysostomos2013-07-041-106/+106
|