release-tools windows doc builds

[sdarwin]

New redis docs were "Adapted from Boost.Unordered".

How was Boost.Unordered able to build docs successfully with both Linux line-endings and Windows line-endings? That is a real question. Probably the answer is this file:

https://github.com/boostorg/unordered/blob/develop/.gitattributes

Notice how it sets the line endings to "LF" for shell scripts .sh.

Without this adjustment, redis breaks the superproject build on CRLF line-endings. windows builds.

I'm running a dos2unix command on the files now, to see if that fixes the releases. Try adding a CI job for docs on windows.

[anarthal]

Sorry for the breakage. I will add the pipeline shortly. Please let me know whether dos2unix was enough or there is anything else to be fixed on our side.

[sdarwin]

It looks like dos2unix works. Builds succeeded. https://app.circleci.com/pipelines/github/boostorg/boost

As far as .gitattributes I wonder if just the lines that specify .sh would be enough? A small file that only adjusts the shell scripts.

[anarthal]

Great. Should we still add the .gitattributes file on our side?

[sdarwin]

Should we still add the .gitattributes file on our side?

Yes, since that would fix Windows builds using CRLF in all cases, even when dos2unix doesn't run, it's more robust.

[anarthal]

@sdarwin I'm trying to understand why this was a problem. I'm not getting what release-tools is really doing here. From this line it seems to be invoking build_antora.sh by hand - why? The docs build in Boost.Redis, even if internally using Antora, should be invoked using ./b2 doc/libs/redis. And AFAIK this applies to Unordered, too.

[sdarwin]

That line is not invoking build_antora.sh. It's converting it to UNIX format. dos2unix .\build_antora.sh

"should be invoked using b2" : b2 calls doc/Jamfile, which in turn will run build_antora.sh.

[anarthal]

I meant the line immediately below: https://github.com/boostorg/release-tools/blob/d27012edbe2516ce8c38798244a153a216ccba95/build_docs/windowsdocs.ps1#L796

"should be invoked using b2" : b2 calls doc/Jamfile, which in turn will run build_antora.sh.

It does, but this is not part of the contract and should not be relied upon.

[sdarwin]

The build_docs directory in release-tools contains convenience scripts to "build docs" locally for individual libraries. Such as redis . It's also used when generated "doc previews".

That's not the main superproject build script: ci_boost_release.py.

ci_boost_release.py does not call build_docs.