Skip to content

Commit

Permalink
Merge pull request #4080 from dod38fr/fix-pod
Browse files Browse the repository at this point in the history
fix missing =over =back in docs/running.pod
  • Loading branch information
coke committed Dec 14, 2020
2 parents e1f09cf + 1331ffd commit 1639c78
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/running.pod
@@ -1,7 +1,16 @@
# This pod file is used in Debian to generate C<raku> man page when
# building C<rakudo> package. At that stage only Perl5 C<pod2man>
# program is available. So this file must follow Perl5's pod syntax.
#
# See https://github.com/rakudo/rakudo/pull/4080#issuecomment-736682853
# for more information.

=head1 NAME
raku - Rakudo Raku Compiler

=encoding UTF-8
=head1 SYNOPSIS
raku [switches] [--] [programfile] [arguments]
Expand Down Expand Up @@ -65,6 +74,8 @@ page|https://github.com/rakudo/rakudo/wiki/dev-env-vars#moarvm>.

=head2 Module loading
=over

=item C<RAKUDOLIB>, C<RAKULIB> (I<Str>; F<src/core/Inc.pm>)
C<RAKUDOLIB> and C<RAKULIB> append a comma-delimited list of paths to the
Expand All @@ -77,8 +88,12 @@ env var C<PERL6LIB> is still available.
If true, causes the module loader to print debugging information to standard
error.

=back

=head2 Error message verbosity and strictness
=over

=item C<RAKU_EXCEPTIONS_HANDLER>
If present, the C<print_exception> routine
Expand Down Expand Up @@ -108,8 +123,12 @@ context line.
Controls whether C<.setting> files are included in backtraces.

=back

=head2 Affecting precompilation
=over

=item C<RAKUDO_PREFIX> (I<Str>; F<src/core.c/CompUnit/RepositoryRegistry.pm6>)
When this is set, Rakudo will look for the standard repositories (perl, vendor,
Expand All @@ -129,8 +148,12 @@ in child processes. Please do not set them manually.
If set to 1, diagnostic information about the precompilation process is
emitted.

=back

=head2 Line editor
=over

=item C<RAKUDO_LINE_EDITOR>
This specifies the preferred line editor to use; valid values are C<Readline>,
Expand All @@ -148,8 +171,12 @@ line editor; the default is C<~/.raku/rakudo-history>.
Before Rakudo version 2020.02 the default was
C<~/.perl6/rakudo-history>.

=back

=head2 Other
=over

=item C<RAKUDO_DEFAULT_READ_ELEMS>
This specifies the default number of characters to read on an
Expand Down Expand Up @@ -200,6 +227,8 @@ Allows to override the NQP installation path. Defaults to
C<[rakudo_executable_dir]/../share/nqp> in relocatable builds and the absolute
path to that folder in non-relocatable builds.

=back

=head1 WINDOWS PECULIARITIES
=head2 Non-console applications
Expand Down

2 comments on commit 1639c78

@sumanstats
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perl and Raku are different languages. The name like Perl5 is redundant after renaming to Raku. So can the Perl5 be only named as Perl?

@lizmat
Copy link
Contributor

@lizmat lizmat commented on 1639c78 Dec 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sumanstats PR's are welcome!

Please sign in to comment.