From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id BCC046D26A for ; Mon, 27 Sep 2021 15:22:16 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id A6C2722290 for ; Mon, 27 Sep 2021 15:22:16 +0200 (CEST) Received: from mail-lf1-x131.google.com (mail-lf1-x131.google.com [IPv6:2a00:1450:4864:20::131]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 56B1C2227B for ; Mon, 27 Sep 2021 15:22:15 +0200 (CEST) Received: by mail-lf1-x131.google.com with SMTP id y26so38004441lfa.11 for ; Mon, 27 Sep 2021 06:22:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=2XwlzEt3YSWezNhh6YvPvR/g/tQETvC3COcWg7NUmsg=; b=hkvQsGXig4so2p/AOkG6BayikbMqmCbCuUuPRx2VoVS+yt3c5/nAd5vs7zASfa0jAe Ytw75R/e0NsqLz7CSob104QUpKm2iFhW/QcEsdIu3MV5n3CiLznqAkxjruOop8Eeh+ZH sWN4i74CTyFzTsOG8Wq6KBx2LqawP/p6IOFXrco5aayPGO6HtSu93is/t3DbwH/gRT3l +18V/3o/HDksZhGnDoVHwgqbfK+JVi42koLYjcyD8yIUfB2rBkvrqwmzI0K7TRkIX6J+ PUI28LC+m3qZE9rL6i4coLV88YBw+hMz1DDyE3oZIxk2IZs9igs7bhf3LoDtUyBCYpw4 td5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=2XwlzEt3YSWezNhh6YvPvR/g/tQETvC3COcWg7NUmsg=; b=uFM8Pw6ceJC4jY1iQpXgVyEoRlmI73B8HqX80DKEm8rICcktx3BPqrBTxFjgEnmWvF RK0VGqhm+078J6v268vQTY1AOnLi2EqnUm1USF0Ga8VLFwiTUarxsLy0yvG84FEjwljN feShzLMEa44GH2QlP2/VyvwaeHvFZWQc7XFQpkIxQKqQYwmWFqiH/+Y20SKproOZTyh1 WXocgGA5y+POBBYN43Gx3pqUSXACeDNWYasMP4ykEEPU4ABNJLfijnOxOHFSZiolIbJv cEfQae+TXUHDoJSHRXK4LpO6rBQISWb1Dm5amD22jfyt+b5XKBb8AiwEDvTqOGm/jywj ByQw== X-Gm-Message-State: AOAM53294ch7x15g42/GOPAysBeB7jRIKblgxkJfq00HvsvAs39RF4Sd DLJAqsDMIyCfnXMIJ2+4Iow24uyhSjVWZW1PuXcQ7AUCcfLhpg== X-Google-Smtp-Source: ABdhPJwli0lr9fqZSjEa4Ucqt6OuqoAV3omZGk1LoDwrtimPIt32NiN+8WpOb5GPYsTm7ZdUK+BSi3CohM0btNtUL68= X-Received: by 2002:a05:6512:12d6:: with SMTP id p22mr25149733lfg.42.1632748928721; Mon, 27 Sep 2021 06:22:08 -0700 (PDT) MIME-Version: 1.0 References: In-Reply-To: From: Sylvain Faivre Date: Mon, 27 Sep 2021 15:21:56 +0200 Message-ID: To: Thomas Lamprecht Cc: Proxmox VE development discussion X-SPAM-LEVEL: Spam detection results: 0 AWL 0.024 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain FREEMAIL_FROM 0.001 Sender email is commonly abused enduser mail provider HTML_MESSAGE 0.001 HTML included in message RCVD_IN_DNSWL_NONE -0.0001 Sender listed at https://www.dnswl.org/, no trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record WEIRD_PORT 0.001 Uses non-standard port number for HTTP Content-Type: text/plain; charset="UTF-8" X-Content-Filtered-By: Mailman/MimeDel 2.1.29 Subject: Re: [pve-devel] building pve-docs - Can't locate PVE/RESTHandler.pm X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 27 Sep 2021 13:22:16 -0000 On Sat, Sep 18, 2021 at 1:07 PM Thomas Lamprecht wrote: > 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 > > Hello, Here is an update on my process : I always get this error when trying to "make index" : make: *** No rule to make target '/usr/share/javascript/proxmox-widget-toolkit-dev/APIViewer.js', needed by 'api-viewer/apidoc.js'. Stop. Following Thomas' suggestion, I tried to : touch api-viewer/apidata.js touch api-viewer/apiddoc.js But it didn't change anything, so for the moment I edited the Makefile to comment the "${API_VIEWER_SOURCES}" in the index.html entry, in order to skip this part. I then had errors for missing binaries : rsvg-convert (provided by the librsvg2-bin Debian package) a2x (provided by the asciidoc Debian package) So I installed these packages on my desktop. I also wanted to install them on my Proxmox server, but asciidoc depends on about 200 packages, and I cannot install all this stuff on the production server. I guess I could build a developement server, but it seems overkill for a small documentation update. On my desktop, I still get the PVE::RESTHandler error, but for a different target now : $ make index ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp PVE_GENERATING_DOCS=1 perl -I. ./gen-cpu-models.conf.5-opts.pl >cpu-models.conf.5-opts.adoc.tmp 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 ./ gen-cpu-models.conf.5-opts.pl line 6. BEGIN failed--compilation aborted at ./gen-cpu-models.conf.5-opts.pl line 6. make: *** [pve-doc-generator.mk:23: cpu-models.conf.5-opts.adoc] Error 2 I think I'm going to write patches for the source files without checking the compile output, it should be OK for small changes. Best regards. Sylvain