Permalink
Browse files

fix some minor issues while reading through README & friends

- whitespaces (+format)
- typos
- style
nothing of interest, really


git-svn-id: http://svn.pugscode.org/pugs@24662 c213334d-75ef-0310-aa23-eaa082d1ae64
  • Loading branch information...
1 parent 70a74c7 commit 878404a122c8c09b76e4ae9d79c02095bc158c4d schwarzer committed Dec 28, 2008
Showing with 65 additions and 60 deletions.
  1. +1 −1 INSTALL.v6
  2. +8 −8 PROBLEMS.pod
  3. +5 −5 READTHEM
  4. +1 −1 READTOO
  5. +1 −1 SLAVES
  6. +2 −2 VICTUALS
  7. +16 −16 t/HOWTO
  8. +20 −20 t/README
  9. +11 −6 t/TASKS
View
@@ -5,7 +5,7 @@ To build Pugs see INSTALL
BUILDING v6
------------------
-v6 is an implementation of Perl 6 on Perl 5.
+v6 is an implementation of Perl 6 on Perl 5.
Its source code also lives in the same repository as Pugs.
(see <http://perlmonks.org/?node_id=559083>)
View
@@ -1,6 +1,6 @@
=head1 NAME
-Current Problems and workarounds
+Current Problems and Workarounds
=head1 AUTHOR
@@ -10,8 +10,8 @@ Various Perl6 Contributors
It is not uncommon for us to do a release, and find some particular
system configuration somewhere is having difficulties. This file is
-intended as a place to accumulate information on symptoms and work
-arounds for the current release. It is mainly intended for developers,
+intended as a place to accumulate information on symptoms and workarounds
+for the current release. It is mainly intended for developers,
rather than users.
=head1 PROBLEM: "cpan -i Task::Smoke" fails because Test-TAP-Model-0.06 install fails.
@@ -20,7 +20,7 @@ B<WORKAROUND:> Force it with "cpan -if Task::TAP::Model".
=head1 PROBLEM: Doesn't build under Debian; aborts with
- "Setup: error reading ./.setup-config"
+ "Setup: error reading ./.setup-config"
B<WORKAROUND:> Install libghc6-network-dev
@@ -55,8 +55,8 @@ version is very uncommon.
There doesn't seem to be an easy way to detect this problem short of
the current "try to link and see if it works".
-=head1 PROBLEM: perl Makefile.PL fails after "Preprocessing library zlib"
- with an error like "Cannot install zlib: 256"
+=head1 PROBLEM: perl Makefile.PL fails after "Preprocessing library zlib"
+ with an error like "Cannot install zlib: 256"
-B<SOLUTION:> Please make sure that your $PATH contains ghc (6.8.2+) binaries
- first, and then run 'perl Makefile.PL' again.
+B<SOLUTION:> Please make sure that your $PATH contains ghc (6.8.2+) binaries
+ first, and then run 'perl Makefile.PL' again.
View
@@ -31,7 +31,7 @@ HaskellDemo - Shae Erisson (aka "shapr")
http://www.haskell.org/hawiki/HaskellDemo
Haskell Tutorial for C Programmers - Eric Etheridge
http://www.haskell.org/~pairwise/intro/intro.html
-Haskell - Various
+Haskell - Various
http://en.wikibooks.org/wiki/Haskell
Write Yourself a Scheme in 48 Hours - Jonathan Tang
http://halogen.note.amherst.edu/%7Ejdtang/scheme_in_48/tutorial/overview.html
@@ -76,15 +76,15 @@ MinCaml: A Simple and Efficient Compiler - Eijiro Sumii
Databases, Types, and The Relational Model: The Third Manifesto
3rd edition, Addison-Wesley, 2006 (ISBN: 0-321-39942-0)
http://www.aw-bc.com/catalog/academic/product/0,1144,0321399420,00.html
- - Christopher J. Date, Hugh Darwen
+ - Christopher J. Date, Hugh Darwen
Database in Depth: Relational Theory for Practitioners
1st edition, Oreilly, 2005 (ISBN: 0-596-10012-4)
- http://www.oreilly.com/catalog/databaseid/ - Christopher J. Date
+ http://www.oreilly.com/catalog/databaseid/ - Christopher J. Date
= Databases - Online
A Relational Model of Data for Large Shared Data Banks
- http://www.acm.org/classics/nov95/toc.html - Edgar F. Codd
+ http://www.acm.org/classics/nov95/toc.html - Edgar F. Codd
Reprinted from I<Communications of the ACM>,
Vol. 13, No. 6, June 1970, pp. 377-387.
Copyright © 1970, Association for Computing Machinery, Inc.
@@ -103,4 +103,4 @@ The Demolished Man - Alfred Bester
Flow My Tears the Policeman Said - Phillip K. Dick
The Curious Incident of the Dog in the Night-Time - Mark Haddon
The Culture series - Iain M. Banks
-The Book of the New Sun tetralogy - Gene Wolfe
+The Book of the New Sun tetralogy - Gene Wolfe
View
@@ -3,7 +3,7 @@ Here are papers which are currently coming up in converstation.
This list is intended to be more transient and speculative than
READTHEM, but less transient, and perhaps more curated, than #perl6.
-It was prompted by my having to grovel over several weeks of irc log
+It was prompted by me having to grovel over several weeks of irc log
to dig up the name of a paper I wanted to read.
Adding comments about the papers is welcome/encouraged.
View
2 SLAVES
@@ -16,6 +16,6 @@ pugs_svn moritz
rakudo_svn moritz
speckbot moritz
-both Auzon and pmurias have access the server on which p6eval and the svn bots
+Both Auzon and pmurias have access the server on which p6eval and the svn bots
run, so if something went wrong and moritz_ isn't available, you can prod
them instead.
View
@@ -16,13 +16,13 @@ Please feel free to add your own personal favourites to this file.
Enjoy!
-Just another concerned Pugs hacker -- 1 April 2005
+Just another concerned Pugs hacker -- 1 April 2005
Blue sugar cubes from the frig Larry Wall
http://www.nntp.perl.org/group/perl.perl6.language/19473
-Diet Coke (preferably caffeine-free) Audrey Tang
+Diet Coke (preferably caffeine-free) Audrey Tang
http://www.perlmonks.org/index.pl?node_id=434659
Quiona from the commie-hippie-traitor Michael Schwern
View
32 t/HOWTO
@@ -4,7 +4,7 @@ This is a guide on how to add tests to the official Perl 6 test suite.
=head2 Pro Forma
-All file pathes in this directory are relative to the root of the pugs
+All file paths in this directory are relative to the root of the pugs
repository (unless stated otherwise). You can obtain the pugs SVN repository
by typing
@@ -24,7 +24,7 @@ list of stuff that needs testing.
=head2 Check the other tests first
Many things are already tested, and it would be waste of time to duplicate the
-effort, and a maintainance burden. So first check if there are tests for the
+effort, and a maintainance burden. So first check if there are tests for the
things you want. Usually a very efficient method is to do a full text search
on the current test suite, either with C<grep> or C<ack> (a perl replacement
for grep, see L<http://search.cpan.org/dist/ack>).
@@ -72,12 +72,12 @@ hyphens, eg C<S99-weird/very-weird-features.t>.
=head2 Write the Tests
-The test suite uses the "Test Anything Protocol" (short TAP), and a module
-named C<Test> that produces the apropriate output. Perl 5 programmers will
+The test suite uses the "Test Anything Protocol" (short TAP), and a module
+named C<Test> that produces the appropriate output. Perl 5 programmers will
be familiar with it because it's very much like L<Test::More>.
Suppose you'd want to test the power operator C<**>. Your test file might
-looking something like that:
+be looking something like this:
use v6;
use Test;
@@ -90,15 +90,15 @@ looking something like that:
Let's go through this line by line.
-The first one tells the compiler that is
-a Perl 6 source file, not Perl 5. The second one load the C<Test> module.
+The first line tells the compiler that it is
+a Perl 6 source file, not Perl 5. The second one loads the C<Test> module.
C<plan 4;> says "we're planning to run 4 tests in this file". If for example
the test silently dies during execution, the TAP parser knows how many tests
you planned to run, and raises an error if it didn't run that many.
The next line is our first real test. It calls the C<is()> function with three
-arguments: the first is the expression whos value is being tested (C<2**4>),
+arguments: the first is the expression whose value is being tested (C<2**4>),
the second is the expected value (C<16>), and the third is a short description
of what the test does.
@@ -113,12 +113,12 @@ which parts of the synopsis. Please add at least one smartlink to each test
file that you write.
Smart links are covered in more detail here:
-
+
http://pugs.blogs.com/pugs/2006/08/integrating_the.html
http://pugs.blogs.com/pugs/2006/09/check_smoke_res.html
http://pugs.blogs.com/pugs/2006/09/the_benefits_of.html
-C<t/README> also contains some information on how smartlinks for.
+C<t/README> also contains some information on how smartlinks work.
In our example we'd go into C<docs/Perl6/Spec> where the synopsis live, and
search for occurences of C<**>:
@@ -133,19 +133,19 @@ The best match seems to be C<Operator.pod>. Looking at
L<http://perlcabal.org/syn/> reveals that it's also called S03 for short. So
we know that our smartlink will start with C<< L<S03/> >>. Next we find out
which section the best match is. That's C<Exponentiation precedence> in our
-case, so our smartlink looks like this:
-C<< L<S03/Exponentiation precedence/> >>.
+case, so our smartlink looks like this:
+C<< L<S03/Exponentiation precedence/> >>.
-The only thing missing is to identify the paragraph. Instead of copying
-the markup, we just use a part of what will be displayed, and put it
+The only thing missing is to identify the paragraph. Instead of copying
+the markup, we just use a part of what will be displayed, and put it
in double quotes:
C<< L<S03/Exponentiation precedence/"infix:<**>"> >>. We place that line
directly after the C<plan> directive in our test file.
=head2 Comitting your changes
Once you've written (or edited) a reasonable test file, you should commit the
-changes to the pugs repositoy.
+changes to the pugs repository.
If you don't have a commit bit (that is the power to commit changes to the
repository) join #perl on irc.freenode.net and ask for one.
@@ -161,7 +161,7 @@ properties. Lazy programmers use a shell script for that:
svn ci -m '[t/spec] test for very weird features' t/spec/S99-weird/very-weird-features.t
Please always include the C<[t/spec]> marker at the beginning of your commit
-messages (or C<[t]> if you didn't modify C<t/spec/>), it helps other to
+messages (or C<[t]> if you didn't modify C<t/spec/>), it helps others to
identify which part of the repository you changed.
=cut
View
@@ -13,7 +13,7 @@
Welcome to the Pugs Test suite.
-Pugs is currently being developed in a highly test-driven manner. Tests are
+Pugs is currently being developed in a highly test-driven manner. Tests are
written for both implemented and unimplemented features and are based roughly
on the Perl6 Language Synopsis documents. All are welcome and encouraged to
contribute to this test suite. The part under spec/ is considered to be the
@@ -24,7 +24,7 @@ Synopsis documents. It is also used by other Perl 6 implementations.
Getting Started
-------------------------------------------------------------------------------
-Here are some basic guidelines to help you get started writing tests for Pugs.
+Here are some basic guidelines to help you get started writing tests for Pugs.
- Prerequisites
@@ -50,7 +50,7 @@ and asking questions is a good thing.
- What to test
-A number of Pugs hackers on #perl6 run regular smoke tests, and you can run
+A number of Pugs hackers on #perl6 run regular smoke tests, and you can run
your own using 'make smoke'. The smoke test produces an HTML graph of what tests
are passing, and what aren't. This can be a good place to start. There's a smoke
server on the web:
@@ -73,20 +73,20 @@ an hour.
- Use the Test module.
-We have created a basic Test module found in ext/Test/lib/Test.pm. It is
-written in Perl 6 and implements the TAP protocol (and so can be used with
-Test::Harness). The module has its own documentation and I encourage you to
-read it.
+We have created a basic Test module found in ext/Test/lib/Test.pm. It is
+written in Perl 6 and implements the TAP protocol (and so can be used with
+Test::Harness). The module has its own documentation and I encourage you to
+read it.
- Pugs tests should have a non-she-bang line of "use v6;".
-This line helps both Test::Harness as well as the 'prove6' utility when
-running Pugs tests.
+This line helps both Test::Harness as well as the 'prove6' utility when
+running Pugs tests.
- Place tests in the appropriate folder.
-We have recently undergone a re-organization of the test suite in order to
-make it easier to find what has and has not been tested. It is important as
+We have recently undergone a re-organization of the test suite in order to
+make it easier to find what has and has not been tested. It is important as
the test suite grows that we try to keep this organization. If you have a test
and are unsure of where to put it, ask on #perl6 for help, or put it in the
general/ folder and email perl6-compiler and let us know.
@@ -128,8 +128,8 @@ util/smartlinks.pl to verify the links' validity:
$ perl util/smartlinks.pl --check t/some/test.t
-By default, the freshness of the synopses will checked every time. Use "--fast"
-to skip that step.
+By default, the freshness of the synopses will be checked every time. Use
+"--fast" to skip that step.
- Dealing with parse failures
@@ -141,24 +141,24 @@ has been implemented correctly.
Sometimes code is so futuristic, it can even confuse eval. We call this a
"hard parsefail". When this happens, comment out the failing code, but mark
-it so it doesn't get forgotten, like so:
+it so it doesn't get forgotten, like this:
todo :pugs<6.28.0>, v6_pm<0.110>;
flunk("FIXME parsefail");
#ok eval('my code here');
-
+
Or another alternate style is as follows:
ok eval('# $code.which(%will, @fail)');
ok eval(q{
- blah blah blah
+ blah blah blah
});
is(eval(q{
- my $val;
- # some code here...
- $val;
+ my $val;
+ # some code here...
+ $val;
}), $expected, 'description');
which essentially comments out your eval, and returns 'undef' to ok().
@@ -172,7 +172,7 @@ The general rule about todo tests is that if the feature is not
yet implemented, it is TODO. But if a feature is broken, or a bug is found
then the tests should fail and *not* be TODO.
-The only exception to this rule is that we TODO all failing tests before
+The only exception to this rule is that we TODO all failing tests before
each point release. This is so 'make test' will succeed :)
Remember, the failing test *is* your bug report.
View
17 t/TASKS
@@ -1,23 +1,28 @@
TASKS for the Perl 6 Test Suite
-Add any requested tests or other updates to this file. Please organize them by synopsis (when applicable) or put them in the OVERALL section at the top if they apply to the test suite in general.
+Add any requested tests or other updates to this file. Please organize them
+by synopsis (when applicable) or put them in the OVERALL section at the top
+if they apply to the test suite in general.
Please also read t/deprecated-syntax.pod for common mistakes in the test
suite, and clear them when you update tests.
-When you are adding entries here, please put something like this in the commit message:
+When you are adding entries here, please put something like this in the
+commit message:
[t/TASKS]: Added more tasks for S02.
-This way, people working on the test suite can easily spot these commits in #perl6.
+This way, people working on the test suite can easily spot these commits
+in #perl6.
-This file had entries in the past (r16405). Since this file wasn't touched in over 4000 commits, I (Auzon) cleared them out.
+This file had entries in the past (r16405). Since this file wasn't touched
+in over 4000 commits, I (Auzon) cleared them out.
OVERALL
* Add smartlinks to tests without them
* Continue moving tests from t/ to t/spec/
* Clean up old POD (only present in some testing modules)
* Review XXX entries for test corrections
* rewrite tests with multiple lexical subs of the same name ("my sub foo") to
- use different names and no "my" (except where testing lexical subs, for
+ use different names and no "my" (except where testing lexical subs, of
course)
S02
@@ -119,7 +124,7 @@ Junction tests
junctions. An intermediate workaround is to use $junction.values.sort, but
what we *really* should have is a sub that tests for junction identity.
That could be an intersting piece of code to write. --moritz
-
+
However, based on discussions at the OSCON 2008 hackathon, there's reason
to believe that .values won't be a method on Junction (or rather, that
.values autothreads overs the members of the Junction set like any other

0 comments on commit 878404a

Please sign in to comment.