Re: Documentation building broken in CFBot

Поиск
Список
Период
Сортировка
От Tom Lane
Тема Re: Documentation building broken in CFBot
Дата
Msg-id 905763.1606595411@sss.pgh.pa.us
обсуждение исходный текст
Ответ на Re: Documentation building broken in CFBot  (Tom Lane <tgl@sss.pgh.pa.us>)
Список pgsql-www
I wrote:
> Peter Eisentraut <peter.eisentraut@enterprisedb.com> writes:
>> In any case, note that there is also documentation about this at
>> <https://www.postgresql.org/docs/devel/docguide-toolsets.html#DOCGUIDE-TOOLSETS-CONFIGURE>
>> that would need to be updated to the new behavior.  I think the phrase
>> "If xmllint was not found then some of the following tests will be
>> skipped." could be removed, since it referred to the DocBook test about
>> to be removed.

> Right.  That also seems like a good place to add a hint about setting
> XMLLINT to 'xmllint --nonet' if you don't want remote fetches to happen
> while building the docs.  Shall we do that instead of applying the
> patch you posted earlier?

Concretely, maybe like the attached?

(Looking at this, I can't avoid the feeling that the programs are being
checked for in a completely random order.  I'm tempted to rearrange
configure to probe xmllint, xsltproc, fop, dbtoepub in that order,
so it matches the proposed documentation.)

            regards, tom lane

diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml
index 17d36e9145..66a1951c5e 100644
--- a/doc/src/sgml/docguide.sgml
+++ b/doc/src/sgml/docguide.sgml
@@ -234,15 +234,31 @@ brew install docbook docbook-xsl fop
    like this:
 <screen>
 checking for xmllint... xmllint
-checking for DocBook XML V4.5... yes
 checking for dbtoepub... dbtoepub
 checking for xsltproc... xsltproc
 checking for fop... fop
 </screen>
-   If <filename>xmllint</filename> was not found then some of the following
-   tests will be skipped.
+   If <filename>xmllint</filename> or <filename>xsltproc</filename> is not
+   found, you will not be able to build any of the documentation.
+   <filename>fop</filename> is only needed to build the documentation in
+   PDF format.
+   <filename>dbtoepub</filename> is only needed to build the documentation
+   in EPUB format.
   </para>
 
+  <para>
+   If necessary, you can tell <filename>configure</filename> where to find
+   these programs, for example
+<screen>
+./configure ... XMLLINT=/opt/local/bin/xmllint ...
+</screen>
+   Also, if you want to ensure that <filename>xmllint</filename>
+   and <filename>xsltproc</filename> will not perform any network access,
+   you can do something like
+<screen>
+./configure ... XMLLINT="xmllint --nonet" XSLTPROC="xsltproc --nonet" ...
+</screen>
+  </para>
   </sect2>
  </sect1>


В списке pgsql-www по дате отправления:

Предыдущее
От: Tom Lane
Дата:
Сообщение: Re: Documentation building broken in CFBot
Следующее
От: mohammad Moghaddaszadeh
Дата:
Сообщение: Wiki editor request