Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs build: flags --maxdepth 100000 #31

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

sdarwin
Copy link

@sdarwin sdarwin commented Sep 15, 2023

The boostorg/contract documentation is able to build in Linux, however not on MacOS or Windows. Not clear why...

If a maintainer is interested I could convert this into an Issue, to keep track of it.

The issue is "be able to build documentation on MacOS and Microsoft Windows". Which may be low priority. It's somewhat interesting to be able to use boost libraries on multiple operating systems. Scripts to facilitate those builds: https://github.com/boostorg/release-tools/tree/master/build_docs

All docs builds, including Linux, show this error:

warning: tag INCLUDE_PATH: include path '../include' does not exist
warning: source '../include' is not a readable file or directory... skipping.

A snippet from MacOS:

Cannot find class named 'Class'
Cannot find class named 'Class'
Cannot find class named 'const'
Cannot find class named 'const'
Cannot find class named 'bool'
Cannot find class named 'bool'
Cannot find class named 'bool'
Cannot find class named 'bool'
Cannot find class named 'bool'
Cannot find class named 'bool'
Cannot find class named 'ifdef'
Cannot find class named 'BOOST_CONTRACT_DETAIL_DOXYGEN'
Cannot find class named 'v'

    XML_CATALOG_FILES="bin.v2/boostbook_catalog.xml"
export XML_CATALOG_FILES
 "xsltproc" --stringparam boost.defaults "Boost" --stringparam boost.root "../../../.." --stringparam toc.max.depth "1" --path "bin.v2" --path "libs/contract/doc/html" --xinclude -o "libs/contract/doc/html/contract.docbook" "/Users/runner/work/release-tools/release-tools/github/boostorg/boost-root/tools/boostbook/xsl/docbook.xsl" "bin.v2/libs/contract/doc/contract.xml"

...failed xslt-xsltproc libs/contract/doc/html/contract.docbook...
...skipped <plibs/contract/doc/html>boostrelease_HTML.manifest for lack of <plibs/contract/doc/html>contract.docbook...
...failed updating 1 target...
...skipped 1 target...
...updated 10 targets...
Error: Process completed with exit code 1.

Errors that appeared on MacOS:

You can adjust xsltMaxDepth (--maxdepth) in order to raise the maximum number of nested template calls and variables/params (currently set to 3000).

You can adjust maxTemplateVars (--maxvars) in order to raise the maximum number of variables/params (currently set to 15000).

Those are fixed in this pull request, by increasing the limits. Should be safe to merge.

<flags>"--maxdepth 100000"
<flags>"--maxvars 300000"

That solves those particular errors, but still not everything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant