Browse files

[codingstd] podcheck parrot.pod

Fixed various non-conformant pod: empty =item, =over for bodies
  • Loading branch information...
1 parent a5bb6bf commit 14fa643cca799ee9d2add56e77ee6026e87b6cbc @rurban rurban committed Sep 25, 2012
Showing with 5 additions and 81 deletions.
  1. +5 −81 docs/binaries/parrot.pod
View
86 docs/binaries/parrot.pod
@@ -1,5 +1,3 @@
-# Copyright (C) 2011-2012, Parrot Foundation.
-
=pod
=head1 NAME
@@ -27,37 +25,29 @@ reasons.
=item B<--help> Print the option summary on the command line.
-=item
-
=item B<-V>
=item B<--version> Print version information and exit.
-=item
-
=item B<-I>
=item B<--include> Add C<path> to the include search path.
-=item
-
=item B<-L>
=item B<--library> Add C<path> to the library search path.
-=item
-
=item B<--hash-seed> [hexnum]
-=over 11
-
Sets the hash seed to the specified value. This option is useful for debugging intermittent
failures, but should I<not> be used in production. For more information about this option,
I<see> F<docs/dev/profiling.pod>, F<docs/project/hacking_tips.pod>, F<docs/running.pod>,
and F<docs/submissions.pod>.
=back
+=over 11
+
=item B<-X>
=item B<--dynext> Add C<path> to the dynamic extension search path.
@@ -75,8 +65,6 @@ information about these options, I<see> the "About runcores" section in F<docs/r
=item B<--runcore> [CORE]
-=over 11
-
Select the runcore. The following cores are available in Parrot, but not all
may be available on your system:
@@ -96,26 +84,18 @@ may be available on your system:
gcdebug performs a full GC run before every op dispatch
(good for debugging GC problems)
-=back
-
=item B<-p>
=item B<--profile> Run with the slow core and print an execution profile.
-=item
-
=item B<-t>
=item B<--trace> Run with the slow core and print trace information to B<stderr>.
-=over 11
-
I<See> C<parrot --help-debug> for available flag bits.
=back
-=back
-
=head2 VM options
=over 4
@@ -124,36 +104,22 @@ I<See> C<parrot --help-debug> for available flag bits.
=item B<--parrot-debug>[=HEXFLAGS]
-=over 11
-
Turn on interpreter debug flag. I<See> C<parrot --help-debug> for available flag bits.
-=back
-
=item B<--help-debug> Print the summary of debugging and tracing flag bits.
-=item
-
=item B<-w>
=item B<--warnings> Turn on warnings.
-=over 11
-
I<See> C<parrot --help-debug> for available flag bits.
-=back
-
=item B<-G>
=item B<--no-gc> Turn off GC.
-=over 11
-
This may prove useful for finding GC-related bugs.
-=back
-
=over 11
=item Note:
@@ -175,12 +141,8 @@ quickly become exhausted.
=item B<--gc-dynamic-threshold>=percentage
-=over 11
-
Maximum memory wasted by GC
-=back
-
=item B<--gc-min-threshold>=Kb
=back
@@ -191,85 +153,55 @@ Maximum memory wasted by GC
=item B<--gc-nursery-size>=percent of system
-=over 11
-
Size of gen0 (default 2)
-=back
-
=item B<--gc-debug> Turn on GC (Garbage Collection) debugging.
-=over 11
-
This imposes some stress on the GC subsystem and can considerably slow
down execution.
-=back
-
=item B<--leak-test|--destroy-at-end>
-=over 11
-
Free all memory of the last interpreter. This is useful when running leak
checkers.
-=back
-
=item B<-.>
=item B<--wait> Read a keystroke before starting.
-=over 11
-
This is useful when you want to attach a debugger on platforms such as Windows.
-=back
-
=item B<--runtime-prefix>
-=over 11
-
Print the runtime prefix path and exit.
=back
-=back
-
=head2 Compiler options
+=over 4
+
=item B<-E>
=item B<--pre-process-only>
-=over 11
-
Preprocess source file (expand macros) and print result to C<stdout>:
$> parrot -E t/op/macro_10.pasm
$> parrot -E t/op/macro_10.pasm | parrot -- -
-=back
-
=item B<-o>
=item B<--output>=FILE Act like an assembler, but do not execute the code,
-=over 11
-
unless the B<-r> is supplied as well. If 'outputfile' ends with F<.pbc>,
'parrot' will write a PBC file. If it ends with F<.pasm>, 'parrot' will output
a PASM file, even from PASM input.
-=back
-
=item B<--output-pbc> Act like an assembler, but always output bytecode,
-=over 11
-
even if the output file does not end in F<.pbc>
-=back
-
=item B<-a>
=item B<--pasm> Assume PASM input on C<stdin>.
@@ -278,25 +210,17 @@ even if the output file does not end in F<.pbc>
=item B<--pbc> Assume PBC file on C<stdin> and execute it.
-=over 11
-
NOTE: If whitespace separates the B<-d> switch from the argument, the argument
I<must> start with a number, I<i.e.>, a decimal digit.
-=back
-
=item B<-r>
=item B<--run-pbc> Only useful after C<-o> or C<--output-pbc>.
-=over 11
-
Execute the program from the compiled in-memory image. If two C<-r> options are
supplied, the F<.pbc> file is read from disc and executed. This is needed,
primarily, for tests.
-=back
-
=item B<-y>
=item B<--yydebug> Turn on yydebug in F<yacc>/F<bison>.
@@ -355,6 +279,6 @@ most of these people, I<see> F<CREDITS>.
=head1 COPYRIGHT
-Copyright (C) 2001-2011, Parrot Foundation.
+Copyright (C) 2001-2012, Parrot Foundation.
=cut

0 comments on commit 14fa643

Please sign in to comment.