Bug 231842

Summary:	/usr/doc: parser error : Failure to process entity chap.mirrors.ftp.index.inc
Product:	Documentation	Reporter:	O. Hartmann <ohartmann>
Component:	Books & Articles	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Closed Overcome By Events
Severity:	Affects Many People	CC:	carlavilla, debdrup
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any
Bug Depends on:	253518
Bug Blocks:

Description O. Hartmann 2018-10-01 07:33:21 UTC

On recent CURRENT (12.0-ALPHA8 #631 r339034: Mon Oct  1 07:59:37 CEST 2018 amd64) with ports tree (assumingly) up to date (make-built ports, ports tree is at r481004 and "portmaster'ed"), the build of the doc tree fails. Checking out a fresh /usr/doc (r52316, https://svn.freebsd.org/doc/head), leaves me with the error as follows:

[...]
env XML_CATALOG_FILES="file:///usr/obj/usr/doc/en_US.ISO8859-1/books/handbook/catalog-cwd.xml  file:///usr/doc/en_US.ISO8859-1/share/xml/catalog.xml  file:///usr/doc/share/xml/catalog.xml  file:///usr/local/share/xml/catalog" /usr/local/bin/xmllint --nonet --noent --valid --dropdtd --xinclude /usr/doc/en_US.ISO8859-1/books/handbook/book.xml > book.parsed.xml.tmp
warning: failed to load external entity "/usr/doc/en_US.ISO8859-1/books/handbook/mirrors.xml.ftp.index.inc"
/usr/doc/en_US.ISO8859-1/books/handbook/mirrors/chapter.xml:100: parser error : Failure to process entity chap.mirrors.ftp.index.inc
    &chap.mirrors.ftp.index.inc;

Comment 1 Sergio Carlavilla Delgado freebsd_committer

2021-04-01 19:54:34 UTC

The documentation site now uses Hugo/AsciiDoc.

Comment 2 O. Hartmann 2021-04-05 18:41:55 UTC

That doesn't solve the problem; reinstalling textproc/docproj (which doesn't pull for emulators/hugo) and having emulators/hugo as well as textproc/asciidoc installed, the recent /usr/doc doesn't build:

# make all
===> documentation (all)
---------------------------------------------------------------
Building the documentation
---------------------------------------------------------------
/usr/local/bin/python3 ./tools/books-toc-parts-creator.py -l en,es,pt-br,de,ja,zh-cn,zh-tw,ru,el,hu,it,mn,nl,pl,fr
/usr/local/bin/python3 ./tools/books-toc-creator.py -l en,es,pt-br,de,ja,zh-cn,zh-tw,ru,el,hu,it,mn,nl,pl,fr
/usr/local/bin/python3 ./tools/books-toc-figures-creator.py -l en,es,pt-br,de,ja,zh-cn,zh-tw,ru,el,hu,it,mn,nl,pl,fr
/usr/local/bin/python3 ./tools/books-toc-tables-creator.py -l en,es,pt-br,de,ja,zh-cn,zh-tw,ru,el,hu,it,mn,nl,pl,fr
/usr/local/bin/python3 ./tools/books-toc-examples-creator.py -l en,es,pt-br,de,ja,zh-cn,zh-tw,ru,el,hu,it,mn,nl,pl,fr
/usr/local/bin/hugo --minify
hugo: unrecognized option `--minify'
Try `hugo --help' or `hugo --usage' for more information.
*** Error code 64

Stop.
make[1]: stopped in /usr/doc/documentation
*** Error code 1


/usr/doc is at the most recent git pull as of today, Mon Apr  5 20:41:16 CEST 2021

Comment 3 Daniel Ebdrup Jensen freebsd_committer

2021-04-06 12:10:37 UTC

To add to this, when the project refers to hugo, ports/www/gohugo is what's referred to, not emulators/hugo - both install the hugo binary, but it might be obvious in hindsight that the website doesn't involve emulation.

There is an outstanding bug for changing the dependencies on textproc/docproj, but if you manually install the tools listed in the freebsd documentation primer quick start at https://docs.freebsd.org/en/books/fdp-primer/#overview-quick-start you should be able to get going.