Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PATCH languages/perl6/perl6] Edit documentation #1

Closed
p6rt opened this issue Nov 15, 2002 · 5 comments
Closed

[PATCH languages/perl6/perl6] Edit documentation #1

p6rt opened this issue Nov 15, 2002 · 5 comments
Labels
docs Anything documentation-related

Comments

@p6rt
Copy link

p6rt commented Nov 15, 2002

Migrated from rt.perl.org#18400 (status was 'resolved')

Searchable as RT18400$

@p6rt
Copy link
Author

p6rt commented Nov 15, 2002

From @chromatic

This patch cleans up some of the documentation for the perl6 utility.

-- c

@p6rt
Copy link
Author

p6rt commented Nov 15, 2002

From @chromatic

p6.patch
Index: perl6
===================================================================
RCS file: /cvs/public/parrot/languages/perl6/perl6,v
retrieving revision 1.25
diff -u -r1.25 perl6
--- perl6	30 Oct 2002 10:52:12 -0000	1.25
+++ perl6	15 Nov 2002 05:48:32 -0000
@@ -792,10 +792,10 @@
 =head1 DESCRIPTION
 
 perl6 calls all the appropriate stages to parse, assemble and run a perl6
-source file. As this steps evolve this program will. Or it will get garbage
-collect somewhere in the future.
+source file. As these steps evolve this program will, or it will be garbage
+collected sometime in the future.
 
-If called with a .imc, .pasm or .pbc file, the appropriate pass(es) will be run.
+If called with .imc, .pasm or .pbc files, the appropriate pass(es) will be run.
 
 =head1 OPTIONS
 
@@ -809,7 +809,7 @@
 
 =item -C|--compile-pbc
 
-Compile to executable and run native. s. also Run options below
+Compile to executable and run native. See also Run options below.
 
 =item -B|--pbc
 
@@ -825,7 +825,7 @@
 
 =item --tree
 
-Stop after creating parse tree, doesn't generate .imc output.
+Stop after creating parse tree, do not generate .imc output.
 
 =item --raw-tree
 
@@ -833,9 +833,9 @@
 
 =item --keep-imc --keep-pasm --keep-pbc --keep-c --keep-o --keep-warn --keep-exe
 
-Keep intermediate file.ext. If perl6 stops with an error or with above
-options, temp files are always kept.
-The last output step (.pmc or executable) is of course kept.
+Keep intermediate file.ext. If perl6 stops with an error or with above options,
+temp files are always kept.  The last output step (.pmc or executable) is of
+course kept.
 
 =item -k|--keep-all
 
@@ -843,19 +843,19 @@
 
 =item --clean
 
-Unlink all files, perl6 might have generated (s. FILES below), except those
-to --keep. E.g.
+Unlink all files perl6 might have generated (see FILES below), except those
+to --keep, e.g.
 
 	perl6 file.p6 --clean --keep-exe
 
 =item --test
 
 Run tests like "make test". As the program startup and parser generation
-are done only once, with this option, tests run much faster.
+are done only once, with this option tests run much faster.
 
 =item --test-parser
 
-Interactive parser-testing mode. The parser enter an interaktive mode, an
+Interactive parser-testing mode. The parser enters an interactive mode. An
 empty line sends input to the parser.
 
 =item -g|--debug-info
@@ -871,7 +871,7 @@
 
 =item --trace
 
-Set $::RD_TRACE. You know what it is, when you want this.
+Set $::RD_TRACE. You know what it is when you want this.
 
 =item --hitem
 
@@ -946,13 +946,13 @@
 
 =item -R..|--parrot-options=bdhjpPgtv.
 
-pass option(s) to parrot, s. parrot -h
+pass option(s) to parrot, see parrot -h.
 
     e.g. "perl6 -Rb. ..."  calls "parrot -b -. ..."
 
 =item --shared
 
-Run against shared dynamic libparrot - you must build it currently manually
+Run against shared dynamic libparrot - you must currently build it manually
 in parrot root with:
 
 	cd ../..
@@ -966,7 +966,7 @@
 
 =item --ignore-exitcode
 
-don't report non zero exit codes. This is needed e.g. for make test,
+Don't report non zero exit codes. This is needed e.g. for make test,
 when native code is tested.
 
 =item --rm-exe
@@ -1022,7 +1022,7 @@
 
 =item echo 'my $a=2; print $a _ "\n"' | perl6 -vvw
 
-Show inidiviudal steps, display warning, intermediate files are named
+Show individual steps, display warning, intermediate files are named
 �a.*�.
 
 =item perl6 mops.pasm
@@ -1033,7 +1033,7 @@
 
 =head1 ENVIRONMENT
 
-As perl6 is written in perl5, s. perldoc perlrun. No environment vars
+As perl6 is written in perl5, see perldoc perlrun. No environment vars
 are used currently.
 
 =head1 FILES
@@ -1078,14 +1078,14 @@
 
 =head1 BUGS
 
-Parrot::Config doesn't provide all info needed to run. So there are
+Parrot::Config doesn't provide all info needed to run, so there are
 some hard coded values at the beginning of the program.
 
 When a intermediate stage dumps core, the message is not in file.warn.
 
 =head1 TODO
 
-- Check for core files, and optionally get bt.
+- Check for core files, and optionally get backtrace
 - clean up source file
 - more use of Parrot::Config
 - use assemble.pl's classes directly

@p6rt
Copy link
Author

p6rt commented Dec 13, 2002

From educated_foo@yahoo.com

Applied thanks.

/s

[chromatic <!--c--> <i>at</i> <!--a--> wgz.org - Thu Nov 14 21​:50​:48 2002]​:

This patch cleans up some of the documentation for the perl6 utility.

-- c

@p6rt
Copy link
Author

p6rt commented Dec 13, 2002

From educated_foo@yahoo.com

Applied thanks.

/s

[chromatic <!--c--> <i>at</i> <!--a--> wgz.org - Thu Nov 14 21​:50​:48 2002]​:

This patch cleans up some of the documentation for the perl6 utility.

-- c

@p6rt p6rt closed this as completed Dec 13, 2002
@p6rt
Copy link
Author

p6rt commented Dec 13, 2002

educated_foo@yahoo.com - Status changed from 'new' to 'resolved'

@p6rt p6rt added the docs Anything documentation-related label Jan 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Anything documentation-related
Projects
None yet
Development

No branches or pull requests

1 participant