[pve-devel] building pve-docs - Can't locate PVE/RESTHandler.pm

Sylvain Faivre sylvainfaivre at gmail.com
Fri Sep 17 16:57:26 CEST 2021


I am planning to submit patches for the Proxmox docs, following my post at

I found the pve-docs git repo, and read through

In order to see the results of my changes, I am trying to compile the docs
from the .adoc source files.
For this, I read the README.adoc file in the pve-docs repo, which says :

> To simplify the documentation task, we keep all Documentation within
> this repository. It is possible to generate the docs without installing
> any additional Proxmox packages with:
>  make pve-doc-generator.mk
>  make index

The first command seems to run fine :
$ make pve-doc-generator.mk
./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp
cat pve-doc-generator.mk.in .pve-doc-depends > pve-doc-generator.mk.tmp
sed -i "s/@RELEASE@$/7.0/" pve-doc-generator.mk.tmp
mv pve-doc-generator.mk.tmp pve-doc-generator.mk
make: 'pve-doc-generator.mk' is up to date.

The second command fails with :
$ make index
./extractapi.pl >api-viewer/apidata.js
Can't locate PVE/RESTHandler.pm in @INC (you may need to install the
PVE::RESTHandler module) (@INC contains: /etc/perl
/usr/local/lib/x86_64-linux-gnu/perl/5.32.1 /usr/local/share/perl/5.32.1
/usr/lib/x86_64-linux-gnu/perl5/5.32 /usr/share/perl5
/usr/lib/x86_64-linux-gnu/perl-base /usr/lib/x86_64-linux-gnu/perl/5.32
/usr/share/perl/5.32 /usr/local/lib/site_perl) at ./extractapi.pl line 6.
BEGIN failed--compilation aborted at ./extractapi.pl line 6.
make: *** [Makefile:155: api-viewer/apidata.js] Error 2

I don't know where to find the PVE::RESTHandler module. What should I do
next ?

Thanks in advance.


More information about the pve-devel mailing list