Merge branch 'master' of github.com:perl6/doc

Author: nxadm

Build.pm

@@ -1,5 +1,5 @@
 # Since the p6doc pod is now moved from 'lib' to 'doc' in the distribution we
-# need this to install pod in the usual place (under 'lib' as a target).
+# need this to install pod under .../share/perl6/doc
 # This fixes p6doc command line use.
 
 use Panda::Common;
@@ -11,7 +11,7 @@ use Panda::Installer;
 class Build is Panda::Builder {
     method build($workdir) {
 
-        my $dest-pref = Panda::Installer.new.default-prefix() ~ '/lib/';
+        my $dest-pref = Panda::Installer.new.default-prefix() ~ '/../doc';
 
         my @files = find(dir => "$workdir/doc", type => 'file').list;
 

Makefile

@@ -23,3 +23,7 @@ help:
 run:
 	@echo "Starting local server…"
 	perl app.pl daemon
+
+clean:
+	rm -rf html/*.html html/.*.html html/routine/ html/type/ html/op/ html/language/ html/syntax/ html/images/type-graph* html/js/search.js
+

bin/p6doc

@@ -1,6 +1,8 @@
 #!/usr/bin/env perl6
 use MONKEY-SEE-NO-EVAL; # until we have a better serialisation
 
+my $PROGRAM-NAME="p6doc";
+
 # die with printing a backtrace
 my class X::P6doc is Exception {
     has $.message;
@@ -28,8 +30,8 @@ sub tempfile() {
 }
 
 sub search-paths() {
-    ((findbin()  X~ <../doc/perl6/lib/ ../lib/> X~ <Type/ Language/ Routine/>).list,
-    @*INC.map({CompUnitRepo.new($_)})».IO».Str.map({ /\/$/ ?? $_ !! $_ ~ '/' }).list).flat.list;
+    # XXX we need a way of getting inline pod from installed modules too
+     ($*REPO.repo-chain()>>.Str X~ </doc/>).grep: *.IO.d
 }
 
 sub module-names(Str $modulename) {
@@ -38,7 +40,9 @@ sub module-names(Str $modulename) {
 }
 
 sub locate-module(Str $modulename) {
-    my $m = (search-paths() X~ module-names($modulename).list).first: *.IO.f;
+    my @candidates = (search-paths() X~ module-names($modulename).list);
+    DEBUG and warn :@candidates.perl;
+    my $m = @candidates.first: *.IO.f;
     unless $m.defined {
         my $message = join "\n",
             "Cannot locate $modulename in any of the following paths:",
@@ -68,7 +72,7 @@ sub show-docs(Str $path, :$section) {
 }
 
 multi sub MAIN() {
-    my $me = $*PROGRAM-NAME.IO.basename;
+    my $me = $PROGRAM-NAME.IO.basename;
 
     say 'What documentation do you want to read?';
     say "Examples: $me Type::Str";
@@ -81,7 +85,7 @@ multi sub MAIN() {
 multi sub MAIN($docee) {
     return MAIN($docee, :f) if defined $docee.index('.') ;
     if INDEX.IO ~~ :e {
-        my %data = EVAL slurp INDEX;
+        my %data = EVALFILE INDEX;
         if %data{$docee} {
             my $newdoc = %data{$docee}[0][0];
             return MAIN($newdoc);
@@ -95,7 +99,7 @@ multi sub MAIN($docee, Bool :$f!) {
     if ! $method {
         my %hits;
         if INDEX.IO ~~ :e {
-            my %data = EVAL slurp INDEX;
+            my %data = EVALFILE INDEX;
 
             my $final-docee = disambiguate-f-search( $docee, %data );
             ($package, $method) = $final-docee.split('.');
@@ -105,7 +109,7 @@ multi sub MAIN($docee, Bool :$f!) {
         } else {
             say 'In order to use unqualified sub and method names like "p6doc -f say"';
             say 'you will need to run "p6doc-index build" to build index.data.';
-            say 'Otherwise use "p6doc -f Str.split" instead of "p6doc -f split" for now.';
+            say 'Otherwise use "p6doc -f Type::Str.split" instead of "p6doc -f split" for now.';
             exit 2;
         }
     } else {

bin/p6doc-index

@@ -27,19 +27,15 @@ multi sub MAIN('path-to-index') {
 multi sub MAIN('build') {
     my %words;
 
-    # XXX p6doc probably uses another path to @*INC which is probably incomplete
-
-    for @*INC.map({CompUnitRepo.new($_)})».IO -> $lib_path is copy {
-        next unless $lib_path.e;
-
-        $lib_path = $lib_path.Str;
+    # XXX should index more than this
+    for ($*REPO.repo-chain()>>.Str X~ </doc/>).grep: *.IO.d  -> $lib_path is copy {
         my @files =  find(:dir($lib_path),:type('file')).map({.IO});
 
         for @files -> $f {
             my $file = $f.path;
             next if $file !~~ /\.pod$/;
             my $pod = substr($file.Str, 0 , $file.Str.chars -4);
-            $pod.=subst(/$lib_path\//,"");
+            $pod.=subst($lib_path,"");
             $pod.=subst(/\//,'::',:g);
             my $section = '';
             for open( $file.Str).lines -> $row {

doc/Language/5to6-nutshell.pod

@@ -1103,7 +1103,7 @@ Perl modules is C<PERL5LIB>.
 
     $ PERL5LIB="/some/module/lib" perl program.pl
 
-In Perl6 this is similar, one merely needs to change a number!  As you
+In Perl 6 this is similar, one merely needs to change a number!  As you
 probably guessed, you just need to use C<PERL6LIB>:
 
     $ PERL6LIB="/some/module/lib" perl6 program.p6
@@ -1113,10 +1113,10 @@ library path within the program via the C<use lib> pragma:
 
     use lib '/some/module/lib'
 
-Note that C<PERL6LIB> is more of a developer convenience in Perl6 (as
+Note that C<PERL6LIB> is more of a developer convenience in Perl 6 (as
 opposed to the equivalent usage of C<PERL5LIB> in Perl5) and shouldn't be
 used by module consumers as it could be removed in the future.  This is
-because Perl6's module loading isn't directly compatible with operating
+because Perl 6's module loading isn't directly compatible with operating
 system paths.
 
 =head2 Misc.
@@ -1220,7 +1220,7 @@ statement:
 
 In order to get this to work, one obviously has to jump through many hoops.
 In the standard use-case where one specifies the functions to be exported
-via the C<is export> role, Perl6 automatically creates the C<EXPORT> sub in
+via the C<is export> role, Perl 6 automatically creates the C<EXPORT> sub in
 the correct manner for you, so one should consider very carefully whether or
 not writing one's own C<EXPORT> routine is worthwhile.
 
@@ -1374,7 +1374,7 @@ your MAD science experiments.
 
 Jeff Goff's Perl::ToPerl6 module for Perl 5 is designed around
 Perl::Critic's framework. It aims to convert Perl5 to compilable (if not
-necessarily running) Perl6 code with the bare minimum of changes. Code
+necessarily running) Perl 6 code with the bare minimum of changes. Code
 transformers are configurable and pluggable, so you can create and
 contribute your own transformers, and customize existing transformers to
 your own needs. You can install the latest release from CPAN, or follow
@@ -1383,7 +1383,7 @@ some point.
 
 =head2 Other sources of translation knowledge
 
-=item L<http://perlgeek.de/en/article/5-to-6>
+=item L<https://perlgeek.de/en/article/5-to-6>
 =item L<https://github.com/Util/Blue_Tiger/>
 =item L<https://perl6advent.wordpress.com/2011/12/23/day-23-idiomatic-perl-6/>
 =item L<http://www.perlfoundation.org/perl6/index.cgi?perl_6_delta_tablet>