raku / rakudoc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from noisegul/perl6-p6doc

6.0 6.0 7.0 1.21 MB

A tool for reading Raku documentation

Home Page: https://docs.raku.org/

License: Artistic License 2.0

Shell 3.86% Raku 96.14%

cli documentation pod raku

rakudoc's People

Contributors

Stargazers

Watchers

Forkers

tbrowder mendel pkmnx mujo-hash opoku pheix

rakudoc's Issues

Tests fail on Linux with Star Bundle 2021.04

alex@alex-workhorse:~$ zef install rakudoc --verbose --update
===> Updating fez mirror: http://360.zef.pm/
===> Updated fez mirror: http://360.zef.pm/
===> Updating cpan mirror: https://raw.githubusercontent.com/ugexe/Perl6-ecosystems/master/cpan1.json
===> Updated cpan mirror: https://raw.githubusercontent.com/ugexe/Perl6-ecosystems/master/cpan1.json
===> Updating p6c mirror: https://raw.githubusercontent.com/ugexe/Perl6-ecosystems/master/p6c1.json
===> Updated p6c mirror: https://raw.githubusercontent.com/ugexe/Perl6-ecosystems/master/p6c1.json
===> Searching for: rakudoc
===> Found: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> [via Zef::Repository::LocalCache]
===> Searching for missing dependencies: Pod::Utilities:ver<0.0.1+>, IO::MiddleMan:ver<1.001003+>
===> Found dependencies: Pod::Utilities:ver<0.0.1>, IO::MiddleMan:ver<1.001003> [via Zef::Repository::LocalCache]
===> Testing: Pod::Utilities:ver<0.0.1>
[Pod::Utilities] t/00-meta.t ................ ok
[Pod::Utilities] t/01-load.t ................ ok
[Pod::Utilities] t/02-pod-convenience.t ..... skipped: Test applicable to git checkout only
[Pod::Utilities] t/03-first-.t .............. ok
[Pod::Utilities] t/04-pod-title.t ........... ok
[Pod::Utilities] t/05-pod-with-title.t ...... ok
[Pod::Utilities] t/06-pod-block.t ........... ok
[Pod::Utilities] t/07-pod-link.t ............ ok
[Pod::Utilities] t/08-pod-bold.t ............ ok
[Pod::Utilities] t/09-pod-code.t ............ ok
[Pod::Utilities] t/10-pod-item.t ............ ok
[Pod::Utilities] t/11-pod-heading.t ......... ok
[Pod::Utilities] t/12-pod-table.t ........... ok
[Pod::Utilities] t/13-pod-lower-headings.t .. ok
[Pod::Utilities] t/14-textify-guts.t ........ ok
[Pod::Utilities] t/15-recurse-until-str.t ... ok
[Pod::Utilities] All tests successful.
[Pod::Utilities] Files=16, Tests=28,  3 wallclock secs ( 0.04 usr  0.01 sys +  4.36 cusr  0.38 csys =  4.79 CPU)
[Pod::Utilities] Result: PASS
===> Testing [OK] for Pod::Utilities:ver<0.0.1>
===> Testing: IO::MiddleMan:ver<1.001003>
[IO::MiddleMan] t/00-use.t .......................... ok
[IO::MiddleMan] t/01-hijack.t ....................... ok
[IO::MiddleMan] t/02-capture.t ...................... ok
[IO::MiddleMan] t/03-mute.t ......................... ok
[IO::MiddleMan] t/04-normal.t ....................... ok
[IO::MiddleMan] t/05-mode-switching.t ............... ok
[IO::MiddleMan] t/06-operate-on-capture-contents.t .. ok
[IO::MiddleMan] t/07-errors.t ....................... ok
[IO::MiddleMan] t/08-hijack-STD.t ................... ok
[IO::MiddleMan] t/09-access-original-handle.t ....... ok
[IO::MiddleMan] All tests successful.
[IO::MiddleMan] Files=10, Tests=24,  3 wallclock secs ( 0.03 usr  0.01 sys +  3.23 cusr  0.24 csys =  3.51 CPU)
[IO::MiddleMan] Result: PASS
===> Testing [OK] for IO::MiddleMan:ver<1.001003>
===> Testing: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
[rakudoc] t/00-load.t .......... ok
[rakudoc] t/01-cmd.t ........... ok
[rakudoc] t/02-cache.t ......... ok
[rakudoc] t/03-documentable.t .. ok
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 23
[rakudoc]     # expected a match with: / '/site' .* 'File::Temp' /
[rakudoc]     #                   got: "Doc /home/alex/rakudo/share/perl6/vendor File::Temp"
[rakudoc]     # You failed 1 test of 3
[rakudoc] # Failed test 'File::Temp'
[rakudoc] # at t/04-compunit.t line 16
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 39
[rakudoc]     # expected a match with: / '/site' .* 'IO::MiddleMan' /
[rakudoc]     #                   got: "Doc /home/alex/.zef/store/IO-MiddleMan.git/3313acd53b6cdf552786c8ec756f00582d155586 IO::MiddleMan"
[rakudoc]     # Failed test 'Render (raw source) looks okay'
[rakudoc]     # at t/04-compunit.t line 40
[rakudoc]     # expected a match with: / ^ 'unit class IO::MiddleMan' /
[rakudoc]     #                   got: "\n"
[rakudoc]     # You failed 2 tests of 3
[rakudoc] # Failed test 'IO::MiddleMan'
[rakudoc] # at t/04-compunit.t line 32
[rakudoc] # You failed 2 tests of 2
[rakudoc] t/04-compunit.t ...... 
[rakudoc] Dubious, test returned 2 (wstat 512, 0x200)
[rakudoc] Failed 2/2 subtests 
[rakudoc] # (Run 'rakudoc -b' to build index:)
[rakudoc] # (- no index built for '/home/alex/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc')
[rakudoc] Indexing 17 docs from '/home/alex/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc' in '/home/alex/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-cache/index'
[rakudoc] # (Error processing document Doc /home/alex/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc/HomePage.pod6: =TITLE element not found in  pod file.)
[rakudoc] # (Error processing document Doc /home/alex/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc/404.pod6: =TITLE element not found in  pod file.)
[rakudoc] t/05-index.t ......... ok
[rakudoc] Test Summary Report
[rakudoc] -------------------
[rakudoc] t/04-compunit.t    (Wstat: 512 Tests: 2 Failed: 2)
[rakudoc]   Failed tests:  1-2
[rakudoc]   Non-zero exit status: 2
[rakudoc] Files=6, Tests=29,  4 wallclock secs ( 0.04 usr  0.00 sys +  7.08 cusr  0.58 csys =  7.70 CPU)
[rakudoc] Result: FAIL
===> Testing [FAIL]: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
Aborting due to test failure: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> (use --force-test to override)

I saw that there was a similar issue open before for BSD, might be worth having a look at the revisions made for that commit.

Handle docs installed as resources/

See: Raku/doc#3206

This needs to coordinate with what the Documentable and doc projects do, but at least we can search installed resources for doc files.

migrate master -> main

Also protect the branch at least minimally.

Windows CI Testing

No testing is done on Windows. It's very likely that rakudoc doesn't work at all on Windows.

Need to set up Appveyor or similar and squash bugs both here and in dependencies.

missing Title in files `=TITLE element not found in pod file.`

Hi, zef install rakudoc fails, due to missing =Tttle elt in 2 files I am running raku v2021.09
using rakubrew: rakubrew v21 Build type: fatpack OS: linux

 $ raku --version
Welcome to 𝐑𝐚𝐤𝐮𝐝𝐨™ v2021.09.
Implementing the 𝐑𝐚𝐤𝐮™ programming language v6.d.
Built on MoarVM version 2021.09.

Error:

$ zef install rakudoc
===> Searching for: rakudoc
===> Searching for missing dependencies: Pod::Utilities:ver<0.0.1+>, IO::MiddleMan:ver<1.001003+>, File::Directory::Tree, File::Temp:ver<0.0.8+>
===> Testing: Pod::Utilities:ver<0.0.1>
===> Testing [OK] for Pod::Utilities:ver<0.0.1>
===> Testing: IO::MiddleMan:ver<1.001003>
===> Testing [OK] for IO::MiddleMan:ver<1.001003>
===> Testing: File::Directory::Tree
===> Testing [OK] for File::Directory::Tree
===> Testing: File::Temp:ver<0.0.8>
===> Testing [OK] for File::Temp:ver<0.0.8>
===> Testing: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 23
[rakudoc]     # expected a match with: / '/site' .* 'File::Temp' /
[rakudoc]     #                   got: "Doc /home/grizzlysmit/.zef/store/File-Temp-0.0.8.tar.gz/File-Temp-0.0.8 File::Temp"
[rakudoc]     # You failed 1 test of 3
[rakudoc] # Failed test 'File::Temp'
[rakudoc] # at t/04-compunit.t line 16
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 39
[rakudoc]     # expected a match with: / '/site' .* 'IO::MiddleMan' /
[rakudoc]     #                   got: "Doc /home/grizzlysmit/.zef/store/IO-MiddleMan.git/3313acd53b6cdf552786c8ec756f00582d155586 IO::MiddleMan"
[rakudoc]     # Failed test 'Render (raw source) looks okay'
[rakudoc]     # at t/04-compunit.t line 40
[rakudoc]     # expected a match with: / ^ 'unit class IO::MiddleMan' /
[rakudoc]     #                   got: "\n"
[rakudoc]     # You failed 2 tests of 3
[rakudoc] # Failed test 'IO::MiddleMan'
[rakudoc] # at t/04-compunit.t line 32
[rakudoc] # You failed 2 tests of 2
[rakudoc] # (Run 'rakudoc -b' to build index:)
[rakudoc] # (- no index built for '/home/grizzlysmit/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc')
[rakudoc] Indexing 17 docs from '/home/grizzlysmit/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc' in '/home/grizzlysmit/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-cache/index'
[rakudoc] # (Error processing document Doc /home/grizzlysmit/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc/HomePage.pod6: =TITLE element not found in  pod file.)
[rakudoc] # (Error processing document Doc /home/grizzlysmit/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc/404.pod6: =TITLE element not found in  pod file.)
===> Testing [FAIL]: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
Aborting due to test failure: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> (use --force-test to override)

cannot install

I am following the instructions verbatim, having installed rakudo (by cloning and building that repo) as well as zef. rakudo and zef work fine for me.

When attempting to install rakudoc as per the instructions, some dependencies are not found. Full output for the zef command:

$ zef --depsonly install ./rakudoc
===> Searching for missing dependencies: Path::Finder:ver<0.2.0+>, Documentable:ver<1.2.5+>, IO::Capture::Simple:ver<0.0.1+>
===> Searching for missing dependencies: Pod::Load:ver<0.5.4>, Pod::To::HTML:ver<0.7.0>, Pod::To::Cached:ver<0.4.0>, Perl6::TypeGraph:ver<2.1.3>:auth<github:antoniogamiz>:api<2>, JSON::Fast:ver<0.9.18>, Terminal::Spinners, Terminal::ANSIColor, node:from<bin>, dot:from<bin>, Temp::Path, IO::Glob
===> Failed to find dependencies: node:from<bin>, dot:from<bin>
Failed to resolve some missing dependencies

Improve README

README should show a sample of reading something from the raku/doc documentation (shown here from a local checkout)

$ RAKUDOC=$HOME/sandbox/doc  raku -I. bin/rakudoc -b
$ RAKUDOC=$HOME/sandbox/doc  raku -I. bin/rakudoc Type/Parameter

Deprecated Code

[rakudoc] Use of the 'CompUnit::PrecompilationStore::File' class seen at:
[rakudoc]   /Users/coke/sandbox/rakudoc/lib/Rakudoc/Pod/Cache.rakumod (Rakudoc::Pod::Cache), line 16
[rakudoc] Please use the 'CompUnit::PrecompilationStore::FileSystem' class instead.

Find similar fix done in raku/doc and apply here.

Allow raku/doc to use '.rakudoc' extension

Raku/doc#3785

Could not find Template::Mustache::TestUtil at line 5 in: ......

Hello, everybody.

Thank's for this tool.

I Tried to install rakudoc from https://github.com/Raku/rakudoc

Made
git clone https://github.com/Raku/rakudoc
then
git submodule update --init --recursive

But could not install:
zef --depsonly install ./rakudoc

After a while failed with this error:

===SORRY!===
Could not find Template::Mustache::TestUtil at line 5 in:
/home/moi/.zef/store/Template-Mustache-1.2.2.tar.gz/Template-Mustache-1.2.2/t/lib
/home/moi/.zef/store/Template-Mustache-1.2.2.tar.gz/Template-Mustache-1.2.2
/home/moi/.zef/store/Template-Mustache-1.2.2.tar.gz/Template-Mustache-1.2.2/lib
/home/moi/.zef/store/JSON-Fast-0.15.tar.gz/JSON-Fast-0.15/lib
/home/moi/.zef/store/Test-META-0.0.16.tar.gz/Test-META-0.0.16/lib
/home/moi/.zef/store/META6-0.0.24.tar.gz/META6-0.0.24/lib
/home/moi/.zef/store/JSON-Class-0.0.15.tar.gz/JSON-Class-0.0.15/lib
/home/moi/.zef/store/JSON-Marshal-0.0.19.tar.gz/JSON-Marshal-0.0.19/lib
/home/moi/.zef/store/JSON-Name-0.0.4.tar.gz/JSON-Name-0.0.4/lib
/home/moi/.zef/store/JSON-Unmarshal.git/e1b6288c5f3165058f36c0f4e171cdf2dfd640da/lib
/home/moi/.zef/store/URI.git/ba27beeda30a3096d94d0956ef79e7d88748988b/lib
/home/moi/.zef/store/License-SPDX-3.11.0.tar.gz/License-SPDX-3.11.0/lib
/home/moi/.perl6
/usr/lib/perl6/site
/usr/lib/perl6/vendor
/usr/lib/perl6
CompUnit::Repository::AbsolutePath<94040151280816>
CompUnit::Repository::NQP<94040085888104>
CompUnit::Repository::Perl5<94040085888144>

Notice that The whole log is here : https://pastebin.com/b14yLm4W

Linux DebianMsrv64 4.19.0-13-rt-amd64 #1 SMP PREEMPT RT Debian 4.19.160-2 (2020-11-28) x86_64 GNU/Linux
raku -v
Welcome to 𝐑𝐚𝐤𝐮𝐝𝐨™ v2020.10.
Implementing the 𝐑𝐚𝐤𝐮™ programming language v6.d.
Built on MoarVM version 2020.10.

which raku --> /usr/local/bin/raku
which perl6 --> /usr/local/bin/perl6

Can give any other informations.
Thank's in advance.

Verify doesn't require installed raku/doc docs

Need to verify this before we disable installation of docs in raku/doc.

t/04-compunit.t should be deleted

Test dependencies (and indeed any dependency) doesn't have to be installed for it to be used. Assuming something is installed (instead of just available) is almost always the wrong thing to do. This is what causes rakudoc to fail its tests if e.g. zef install rakudoc is run on a rakudo with no modules installed yet.

does not play well with Documentable<2.0.1>?

I'm getting errors after installing the latest Documentable:

$ RAKUDOC_TEST=1 raku -Ilib bin/rakudoc Map
---
Required named parameter 'source-path' not passed
  in method new at /home/chirvasitua/repos/rakudo/install/share/perl6/site/sources/7A1EC2F61DC88C20EC5E1DDC958184DE00AA3998 (Documentable::Primary) line 48
  in sub process-type-pod-files at /home/chirvasitua/repos/rakudoc/lib/Rakudoc.rakumod (Rakudoc) line 34
  in sub single-query at /home/chirvasitua/repos/rakudoc/lib/Rakudoc/CMD.rakumod (Rakudoc::CMD) line 127
  in sub MAIN at /home/chirvasitua/repos/rakudoc/lib/Rakudoc/CMD.rakumod (Rakudoc::CMD) line 111
  in sub MAIN at /home/chirvasitua/repos/rakudoc/lib/Rakudoc/CMD.rakumod (Rakudoc::CMD) line 55
  in block <unit> at bin/rakudoc line 3

I'm getting this on all machines sporting the latest Documentable (namely 2.0.1).

OS X CI Testing

No testing is done on OS X. It's likely that rakudoc works there, but not known.

Need to set up Travis or similar to ensure OS X is supported.

rakudoc does not find installed modules

Rakudoc only looks at the docs directory, it does not search for modules in $*REPO and check them for documentation.

Also missing is checks for docs as resources.

Need a release

The version available from zef is broken - the version on HEAD seems fine.

Can someone bump the version and do a release? (and potentially document that process so others can do it as needed?)

Tests fail on Fedora using rakubrew with moar-2022.07

Have an issue similar to #11 and #12.

I am using rakubrew with version moar-2022.07 installed. I am on Fedora 36.

On a fresh installed version using rakubrew, trying to install rakudoc with zef results in failed tests:

[somebody@somehost ~]$ zef install rakudoc
===> Searching for: rakudoc
===> Searching for missing dependencies: Pod::Utilities:ver<0.0.1+>, IO::MiddleMan:ver<1.001003+>, File::Directory::Tree, File::Temp:ver<0.0.8+>
===> Searching for missing dependencies: Test::META
===> Searching for missing dependencies: META6:ver<0.0.24+>, URI, License::SPDX
===> Searching for missing dependencies: JSON::Class:ver<0.0.15+>, JSON::Name, JSON::Fast, JSON::Class:ver<0.0.14+>
===> Searching for missing dependencies: JSON::Marshal:ver<0.0.23+>, JSON::Unmarshal:ver<0.08+>, JSON::OptIn
===> Testing: JSON::Fast:ver<0.17>:auth<cpan:TIMOTIMO>
===> Testing [OK] for JSON::Fast:ver<0.17>:auth<cpan:TIMOTIMO>
===> Testing: JSON::OptIn:ver<0.0.2>:auth<zef:jonathanstowe>
===> Testing [OK] for JSON::OptIn:ver<0.0.2>:auth<zef:jonathanstowe>
===> Testing: JSON::Name:ver<0.0.7>:auth<zef:jonathanstowe>:api<1.0>
===> Testing [OK] for JSON::Name:ver<0.0.7>:auth<zef:jonathanstowe>:api<1.0>
===> Testing: JSON::Marshal:ver<0.0.24>:auth<zef:jonathanstowe>:api<1.0>
===> Testing [OK] for JSON::Marshal:ver<0.0.24>:auth<zef:jonathanstowe>:api<1.0>
===> Testing: JSON::Unmarshal:ver<0.11>:auth<zef:raku-community-modules>
===> Testing [OK] for JSON::Unmarshal:ver<0.11>:auth<zef:raku-community-modules>
===> Testing: JSON::Class:ver<0.0.19>:auth<zef:jonathanstowe>:api<1.0>
===> Testing [OK] for JSON::Class:ver<0.0.19>:auth<zef:jonathanstowe>:api<1.0>
===> Testing: META6:ver<0.0.29>:auth<zef:jonathanstowe>:api<1.0>
===> Testing [OK] for META6:ver<0.0.29>:auth<zef:jonathanstowe>:api<1.0>
===> Testing: URI:ver<0.3.5>
===> Testing [OK] for URI:ver<0.3.5>
===> Testing: License::SPDX:ver<3.18.0>:auth<zef:jonathanstowe>:api<1.0>
===> Testing [OK] for License::SPDX:ver<3.18.0>:auth<zef:jonathanstowe>:api<1.0>
===> Testing: Test::META:ver<0.0.19>:auth<zef:jonathanstowe>:api<1.0>
[Test::META] # the following may make some diagnostics from the module itself
===> Testing [OK] for Test::META:ver<0.0.19>:auth<zef:jonathanstowe>:api<1.0>
===> Testing: Pod::Utilities:ver<0.0.1>
===> Testing [OK] for Pod::Utilities:ver<0.0.1>
===> Testing: IO::MiddleMan:ver<1.001004>:auth<zef:raku-community-modules>
===> Testing [OK] for IO::MiddleMan:ver<1.001004>:auth<zef:raku-community-modules>
===> Testing: File::Directory::Tree
===> Testing [OK] for File::Directory::Tree
===> Testing: File::Temp:ver<0.0.10>:auth<zef:rbt>
===> Testing [OK] for File::Temp:ver<0.0.10>:auth<zef:rbt>
===> Testing: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
[rakudoc] Saw 1 occurrence of deprecated code.
[rakudoc] ================================================================================
[rakudoc] Use of the 'CompUnit::PrecompilationStore::File' class seen at:
[rakudoc]   /home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/lib/Rakudoc/Pod/Cache.rakumod (Rakudoc::Pod::Cache), line 16
[rakudoc] Please use the 'CompUnit::PrecompilationStore::FileSystem' class instead.
[rakudoc] --------------------------------------------------------------------------------
[rakudoc] Please contact the author to have these occurrences of deprecated code
[rakudoc] adapted, so that this message will disappear!
[rakudoc] Saw 1 occurrence of deprecated code.
[rakudoc] ================================================================================
[rakudoc] Use of the 'CompUnit::PrecompilationStore::File' class seen at:
[rakudoc]   /home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/lib/Rakudoc/Pod/Cache.rakumod (Rakudoc::Pod::Cache), line 16
[rakudoc] Please use the 'CompUnit::PrecompilationStore::FileSystem' class instead.
[rakudoc] --------------------------------------------------------------------------------
[rakudoc] Please contact the author to have these occurrences of deprecated code
[rakudoc] adapted, so that this message will disappear!
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 23
[rakudoc]     # expected a match with: / '/site' .* 'File::Temp' /
[rakudoc]     #                   got: "Doc /home/somebody/.zef/tmp/69f79c4c08341b8e5afcc414585cea34083ec4f5.tar.gz/dist File::Temp"
[rakudoc]     # You failed 1 test of 3
[rakudoc] # Failed test 'File::Temp'
[rakudoc] # at t/04-compunit.t line 16
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 39
[rakudoc]     # expected a match with: / '/site' .* 'IO::MiddleMan' /
[rakudoc]     #                   got: "Doc /home/somebody/.zef/tmp/f0dad0ce47aa40cae217a0431f05a1d6ac40ebe8.tar.gz/dist IO::MiddleMan"
[rakudoc]     # Failed test 'Render (raw source) looks okay'
[rakudoc]     # at t/04-compunit.t line 40
[rakudoc]     # expected a match with: / ^ 'unit class IO::MiddleMan' /
[rakudoc]     #                   got: "\n"
[rakudoc]     # You failed 2 tests of 3
[rakudoc] # Failed test 'IO::MiddleMan'
[rakudoc] # at t/04-compunit.t line 32
[rakudoc] # You failed 2 tests of 2
[rakudoc] Saw 1 occurrence of deprecated code.
[rakudoc] ================================================================================
[rakudoc] Use of the 'CompUnit::PrecompilationStore::File' class seen at:
[rakudoc]   /home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/lib/Rakudoc/Pod/Cache.rakumod (Rakudoc::Pod::Cache), line 16
[rakudoc] Please use the 'CompUnit::PrecompilationStore::FileSystem' class instead.
[rakudoc] --------------------------------------------------------------------------------
[rakudoc] Please contact the author to have these occurrences of deprecated code
[rakudoc] adapted, so that this message will disappear!
[rakudoc] # (Run 'rakudoc -b' to build index:)
[rakudoc] # (- no index built for '/home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/t/test-doc')
[rakudoc] Indexing 17 docs from '/home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/t/test-doc' in '/home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/t/test-cache/index'
[rakudoc] # (Error processing document Doc /home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/t/test-doc/HomePage.pod6: =TITLE element not found in  pod file.)
[rakudoc] # (Error processing document Doc /home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/t/test-doc/404.pod6: =TITLE element not found in  pod file.)
[rakudoc] Saw 1 occurrence of deprecated code.
[rakudoc] ================================================================================
[rakudoc] Use of the 'CompUnit::PrecompilationStore::File' class seen at:
[rakudoc]   /home/somebody/.zef/tmp/rakudoc%3Aver%3C0.2.4%3E%3Aauth%3Ccpan%3ASOFTMOTH%3E%3Aapi%3C1%3E.tar.gz/rakudoc-0.2.4/lib/Rakudoc/Pod/Cache.rakumod (Rakudoc::Pod::Cache), line 16
[rakudoc] Please use the 'CompUnit::PrecompilationStore::FileSystem' class instead.
[rakudoc] --------------------------------------------------------------------------------
[rakudoc] Please contact the author to have these occurrences of deprecated code
[rakudoc] adapted, so that this message will disappear!
===> Testing [FAIL]: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
Aborting due to test failure: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> (use --force-test to override)

Tests fails on OpenBSD

andinus@hafnium ~>  zef install rakudoc --verbose --update  
[...]
===> Searching for: rakudoc
===> Found: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> [via Zef::Repository::Ecosystems<cpan>]
===> Searching for missing dependencies: Pod::Utilities:ver<0.0.1+>, IO::MiddleMan:ver<1.001003+>
===> Found dependencies: IO::MiddleMan:ver<1.001003>, Pod::Utilities:ver<0.0.1> [via Zef::Repository::Ecosystems<p6c>]
===> Fetching [OK]: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> to /home/andinus/.zef/tmp/1620145901.91342.2941.2434458027615/rakudoc-0.2.4.tar.gz
===> Fetching [OK]: IO::MiddleMan:ver<1.001003> to /home/andinus/.zef/tmp/1620145901.91342.9017.532487444416/IO-MiddleMan.git
===> Fetching [OK]: Pod::Utilities:ver<0.0.1> to /home/andinus/.zef/tmp/1620145901.91342.5606.575010580208/Pod-Utilities.git
===> Extraction [OK]: rakudoc to /home/andinus/.zef/store/rakudoc-0.2.4.tar.gz
===> Extraction [OK]: IO::MiddleMan:ver<1.001003+> to /home/andinus/.zef/store/IO-MiddleMan.git
===> Extraction [OK]: Pod::Utilities:ver<0.0.1+> to /home/andinus/.zef/store/Pod-Utilities.git
[...]
[Pod::Utilities] Result: PASS
===> Testing [OK] for Pod::Utilities:ver<0.0.1>
[...]
[IO::MiddleMan] Result: PASS
===> Testing [OK] for IO::MiddleMan:ver<1.001003>
===> Testing: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
[rakudoc] t/00-load.t .......... ok
[rakudoc] t/01-cmd.t ........... ok
[rakudoc] t/02-cache.t ......... ok
[rakudoc] t/03-documentable.t .. ok
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 23
[rakudoc]     # expected a match with: / '/site' .* 'File::Temp' /
[rakudoc]     #                   got: "Doc /home/andinus/star/share/perl6/vendor File::Temp"
[rakudoc]     # You failed 1 test of 3
[rakudoc] # Failed test 'File::Temp'
[rakudoc] # at t/04-compunit.t line 16
[rakudoc]     # Failed test 'Gist looks okay'
[rakudoc]     # at t/04-compunit.t line 39
[rakudoc]     # expected a match with: / '/site' .* 'IO::MiddleMan' /
[rakudoc]     #                   got: "Doc /home/andinus/.zef/store/IO-MiddleMan.git/3313acd53b6cdf552786c8ec756f00582d155586 IO::MiddleMan"
[rakudoc]     # Failed test 'Render (raw source) looks okay'
[rakudoc]     # at t/04-compunit.t line 40
[rakudoc]     # expected a match with: / ^ 'unit class IO::MiddleMan' /
[rakudoc]     #                   got: "\n"
[rakudoc]     # You failed 2 tests of 3
[rakudoc] # Failed test 'IO::MiddleMan'
[rakudoc] # at t/04-compunit.t line 32
[rakudoc] # You failed 2 tests of 2
[rakudoc] t/04-compunit.t ...... 
[rakudoc] Dubious, test returned 2 (wstat 512, 0x200)
[rakudoc] Failed 2/2 subtests 
[rakudoc] # (Run 'rakudoc -b' to build index:)
[rakudoc] # (- no index built for '/home/andinus/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc')
[rakudoc] Indexing 17 docs from '/home/andinus/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc' in '/home/andinus/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-cache/index'
[rakudoc] # (Error processing document Doc /home/andinus/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc/HomePage.pod6: =TITLE element not found in  pod file.)
[rakudoc] # (Error processing document Doc /home/andinus/.zef/store/rakudoc-0.2.4.tar.gz/rakudoc-0.2.4/t/test-doc/404.pod6: =TITLE element not found in  pod file.)
[rakudoc] t/05-index.t ......... ok
[rakudoc] Test Summary Report
[rakudoc] -------------------
[rakudoc] t/04-compunit.t    (Wstat: 512 Tests: 2 Failed: 2)
[rakudoc]   Failed tests:  1-2
[rakudoc]   Non-zero exit status: 2
[rakudoc] Files=6, Tests=29, [...]
[rakudoc] Result: FAIL
===> Testing [FAIL]: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1>
Aborting due to test failure: rakudoc:ver<0.2.4>:auth<github:Raku>:api<1> (use --force-test to override)

Missing functionality

https://stackoverflow.com/questions/75670079/how-to-update-raku-documentations-which-p6doc-will-read

User notes that they expect to be able to use 'Str', not 'Type/Str', or Str.foo to get a method on that page.

I assume this used to be available in the p6doc version of the app; let's add it back (and test for it)

raku / rakudoc Goto Github PK

rakudoc's People

Contributors

Stargazers

Watchers

Forkers

rakudoc's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs