From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
Sylvain Faivre <sylvainfaivre@gmail.com>
Subject: Re: [pve-devel] building pve-docs - Can't locate PVE/RESTHandler.pm
Date: Sat, 18 Sep 2021 13:06:27 +0200 [thread overview]
Message-ID: <a804d612-49e3-c267-5fb6-b4cdb889345a@proxmox.com> (raw)
In-Reply-To: <CAJW3_vSxj4vo7Ae6JVOVXmEV0Lt9NNtZQhuXz_vzCYHEMqnRrg@mail.gmail.com>
Hi,
On 17.09.21 16:57, Sylvain Faivre wrote:
> I am planning to submit patches for the Proxmox docs, following my post at
> https://forum.proxmox.com/threads/some-notes-and-questions-about-proxmox-cluster-networking.96001/
>
> I found the pve-docs git repo, and read through
> https://pve.proxmox.com/wiki/Developer_Documentation
>
> 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 ?
>
The Makefile target dependencies are not ideal for a minimal-build-dependency build,
but you should be able to workaround that by faking that the extracted api is already
up-to-date step doing something like:
touch api-viewer/apidata.js
make index
cheers,
Thomas
next prev parent reply other threads:[~2021-09-18 11:07 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-17 14:57 Sylvain Faivre
2021-09-17 18:16 ` Georges Martin
2021-09-18 10:51 ` Sylvain Faivre
2021-09-18 11:06 ` Thomas Lamprecht [this message]
2021-09-27 13:21 ` Sylvain Faivre
2021-09-18 5:21 Dietmar Maurer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a804d612-49e3-c267-5fb6-b4cdb889345a@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
--cc=sylvainfaivre@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.