From: Karen Etheridge Date: Sat, 8 Sep 2012 19:09:47 +0000 (-0700) Subject: lots of C<> markup X-Git-Tag: v1.004002~3^2~4 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=25877bf22da1da78dc6baa2eced627ce92d78114;p=p5sagit%2Fstrictures.git lots of C<> markup --- diff --git a/lib/strictures.pm b/lib/strictures.pm index e1f6225..e2353f7 100644 --- a/lib/strictures.pm +++ b/lib/strictures.pm @@ -97,11 +97,11 @@ except when called from a file which matches: (caller)[1] =~ /^(?:t|xt|lib|blib)/ -and when either '.git' or '.svn' is present in the current directory (with -the intention of only forcing extra tests on the author side) - or when '.git' -or '.svn' is present two directories up along with 'dist.ini' (which would -indicate we are in a 'dzil test' operation, via L) - -or when the PERL_STRICTURES_EXTRA environment variable is set, in which case +and when either C<.git> or C<.svn> is present in the current directory (with +the intention of only forcing extra tests on the author side) - or when C<.git> +or C<.svn> is present two directories up along with C (which would +indicate we are in a C operation, via L) - +or when the C environment variable is set, in which case use strictures 1; @@ -113,12 +113,12 @@ is equivalent to no multidimensional; no bareword::filehandles; -Note that _EXTRA may at some point add even more tests, with only a minor -version increase, but any changes to the effect of 'use strictures' in +Note that C may at some point add even more tests, with only a minor +version increase, but any changes to the effect of C in normal mode will involve a major version bump. If any of the extra testing modules are not present, strictures will -complain loudly, once, via warn(), and then shut up. But you really +complain loudly, once, via C, and then shut up. But you really should consider installing them, they're all great anti-footgun tools. =head1 DESCRIPTION @@ -126,7 +126,7 @@ should consider installing them, they're all great anti-footgun tools. I've been writing the equivalent of this module at the top of my code for about a year now. I figured it was time to make it shorter. -Things like the importer in 'use Moose' don't help me because they turn +Things like the importer in C don't help me because they turn warnings on but don't make them fatal - which from my point of view is useless because I want an exception to tell me my code isn't warnings clean. @@ -143,15 +143,15 @@ cost of blowing things up on another machine. Therefore, strictures turns on additional checking, but only when it thinks it's running in a test file in a VCS checkout - though if this causes undesired behaviour this can be overridden by setting the -PERL_STRICTURES_EXTRA environment variable. +C environment variable. If additional useful author side checks come to mind, I'll add them to the -_EXTRA code path only - this will result in a minor version increase (i.e. +C code path only - this will result in a minor version increase (i.e. 1.000000 to 1.001000 (1.1.0) or similar). Any fixes only to the mechanism of this code will result in a subversion increas (i.e. 1.000000 to 1.000001 (1.0.1)). -If the behaviour of 'use strictures' in normal mode changes in any way, that +If the behaviour of C in normal mode changes in any way, that will constitute a major version increase - and the code already checks when its version is tested to ensure that @@ -168,12 +168,12 @@ This method does the setup work described above in L =head2 VERSION -This method traps the strictures->VERSION(1) call produced by a use line +This method traps the C<< strictures->VERSION(1) >> call produced by a use line with a version number on it and does the version check. =head1 EXTRA TESTING RATIONALE -Every so often, somebody complains that they're deploying via 'git pull' +Every so often, somebody complains that they're deploying via C and that they don't want strictures to enable itself in this case - and that setting C to 0 isn't acceptable (additional ways to disable extra testing would be welcome but the discussion never seems to get @@ -190,7 +190,7 @@ final optree to my knowledge, so the author gets some additional compile time crashes which he/she then fixes, and the rest of the testing is completely valid for all environments. -The point of the extra testing - especially 'no indirect' - is to catch +The point of the extra testing - especially C - is to catch mistakes that newbie users won't even realise are mistakes without help. For example, @@ -212,7 +212,7 @@ Additionally, strictures' policy is very much "try and provide as much protection as possible for newbies - who won't think about whether there's an option to turn on or not" - so having only the environment variable is not sufficient to achieve that (I get to explain that you need to add -'use strict' at least once a week on freenode #perl - newbies sometimes +C at least once a week on freenode #perl - newbies sometimes completely skip steps because they don't understand that that step is important).