run-docs-build: allow build warnings again
PATCH 1/1 run-docs-build: allow build warnings again
From: Michael Opdenacker <[email protected]>
This allows to switch to a more recent of Sphinx which will generate warnings with old versions of docs.
This way, it's not immediately necessary to patch
all such versions.
This commit reverts
https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=8273124feb9da2ffe93fcee7c4529d5597e1684a
which originally reverted
https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=931d409b255a85f2217ca093d8391a678ce00ddb
--- scripts/run-docs-build | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
scripts/run-docs-build +2 -2
@@ -63,7 +63,7 @@ for branch in 1.46 $(git branch --remote --contains "$first_sphinx_commit" --for git checkout $branch git checkout master releases.rst make clean - make publish + SPHINXOPTS="-j auto" make publish if [ "$branch" = "master-next" ]; then branch="next"
@@ -136,7 +136,7 @@ for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- fi make clean - make publish + SPHINXOPTS="-j auto" make publish # Strip yocto- from tag names branch=$(echo "$branch" | sed 's/yocto-//')
Signature · 1 line
2.34.1
Hi Michael,
Quoted 32 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
This allows to switch to a more recent of Sphinx which will generate warnings with old versions of docs.
This way, it's not immediately necessary to patch
all such versions.This commit reverts
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D8273124feb9da2ffe93fcee7c4529d5597e1684a&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=9u5-2R_NLEQy5w0pFgklKIUQnAvVLuHX1ASaeEBBJJ4&e=
which originally reverted
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D931d409b255a85f2217ca093d8391a678ce00ddb&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=bTED2gTptfT6bSvLayy3fEpQJyUdbo5gLlt7ZGKkD1c&e=Signed-off-by Michael Opdenacker <[email protected]>--- scripts/run-docs-build | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/run-docs-build +1
-1@@ -63,7 +63,7 @@ for branch in 1.46 $(git branch --remote --contains "$first_sphinx_commit" --for git checkout $branch git checkout master releases.rst make clean - make publish + SPHINXOPTS="-j auto" make publish if [ "$branch" = "master-next" ]; then branch="next"
scripts/run-docs-build for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- · line 140
Quoted 6 lines
scripts/run-docs-build +1
-1@@ -136,7 +136,7 @@ for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- fi make clean - make publish + SPHINXOPTS="-j auto" make publish
What about doing this for all branches except master? To have at least some checks and not completely disable the warnings.
I'm a bit afraid we'll just not care about warnings anymore since they won't fail the autobuilder anymore. I also understand it's not really sustainable to leave them on for old docs since they won't be maintained at one point in time but we still very mnuch would like to be able to build them.
Not sure what's the best solution here right now unfortunately :/
Cheers,
Quentin
Quoted 45 lines · Quentin Schulz
Hi Michael,
Quoted 32 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
This allows to switch to a more recent of Sphinx which will generate warnings with old versions of docs.
This way, it's not immediately necessary to patch
all such versions.This commit reverts
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D8273124feb9da2ffe93fcee7c4529d5597e1684a&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=9u5-2R_NLEQy5w0pFgklKIUQnAvVLuHX1ASaeEBBJJ4&e=
which originally reverted
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D931d409b255a85f2217ca093d8391a678ce00ddb&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=bTED2gTptfT6bSvLayy3fEpQJyUdbo5gLlt7ZGKkD1c&e=Signed-off-by Michael Opdenacker <[email protected]>--- scripts/run-docs-build | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/run-docs-build +1
-1@@ -63,7 +63,7 @@ for branch in 1.46 $(git branch --remote --contains "$first_sphinx_commit" --for git checkout $branch git checkout master releases.rst make clean - make publish + SPHINXOPTS="-j auto" make publish if [ "$branch" = "master-next" ]; then branch="next"scripts/run-docs-build for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- · line 140
Quoted 6 lines
scripts/run-docs-build +1
-1@@ -136,7 +136,7 @@ for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- fi make clean - make publish + SPHINXOPTS="-j auto" make publishWhat about doing this for all branches except master? To have at least some checks and not completely disable the warnings.
Quoted 7 lines
I'm a bit afraid we'll just not care about warnings anymore since they won't fail the autobuilder anymore. I also understand it's not really sustainable to leave them on for old docs since they won't be maintained at one point in time but we still very mnuch would like to be able to build them.
Not sure what's the best solution here right now unfortunately :/
Enabling them for master could be a compromise, I'd take such a patch (Michael is away for a while).
Cheers,
Richard
Hi Richard, Michael,
Quoted 52 lines · Richard Purdie
Quoted 51 lines · Quentin Schulz
Hi Michael,
Quoted 32 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
This allows to switch to a more recent of Sphinx which will generate warnings with old versions of docs.
This way, it's not immediately necessary to patch
all such versions.This commit reverts
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D8273124feb9da2ffe93fcee7c4529d5597e1684a&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=9u5-2R_NLEQy5w0pFgklKIUQnAvVLuHX1ASaeEBBJJ4&e=
which originally reverted
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D931d409b255a85f2217ca093d8391a678ce00ddb&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=bTED2gTptfT6bSvLayy3fEpQJyUdbo5gLlt7ZGKkD1c&e=Signed-off-by Michael Opdenacker <[email protected]>--- scripts/run-docs-build | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/run-docs-build +1
-1@@ -63,7 +63,7 @@ for branch in 1.46 $(git branch --remote --contains "$first_sphinx_commit" --for git checkout $branch git checkout master releases.rst make clean - make publish + SPHINXOPTS="-j auto" make publish if [ "$branch" = "master-next" ]; then branch="next"scripts/run-docs-build for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- · line 140
Quoted 6 lines
scripts/run-docs-build +1
-1@@ -136,7 +136,7 @@ for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- fi make clean - make publish + SPHINXOPTS="-j auto" make publishWhat about doing this for all branches except master? To have at least some checks and not completely disable the warnings.
I'm a bit afraid we'll just not care about warnings anymore since they won't fail the autobuilder anymore. I also understand it's not really sustainable to leave them on for old docs since they won't be maintained at one point in time but we still very mnuch would like to be able to build them.
Quoted 5 lines
Quoted 1 line
Not sure what's the best solution here right now unfortunately :/
Enabling them for master could be a compromise, I'd take such a patch (Michael is away for a while).
Some warnings are actually valid. Such is the case for the one that warranted https://git.yoctoproject.org/yocto-docs/commit/?id=9a797dedf6708da3e7ce789c5c8735e5d891cde4. The issue is that we build the docs from old versions with the same version of sphinx. Therefore, this patch fixes the issue in master but should also be backported to all other impacted versions, even the unmaintained ones. See https://docs.yoctoproject.org/dunfell/dev-manual/dev-manual-common-tasks.html#recipe-syntax, instead of a link we now have a path between quotes.
There are two ways to fix that one warning:
- add intersphinx_disabled_reftypes=[] in conf.py manually from the
run-docs-build script, c.f. https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
- patch all (tagged and branch) releases from 3.2 to current master inscripts/docs-build-patches,
I prefer the second option because it feels less hacky, but that means MANY times the same file added to docs-build-patches directory.
The same could be done for the patch I just sent for yocto-docs to use the %s substitution characters for the cve extlinks to fix a warning. We could just apply this patch to affected releases (kirkstone-4.0.1 tag + kirkstone branch). I could technically request a backport to yocto-docs kirkstone branch, the only thing I don't like is bumping the min version requirement for sphinx for a release that was already released, but if that's okay with you, we could avoid having to add patches in the autobuilder for every new tagged release of kirkstone.
I'm honestly not sure there's a lot of benefit in disabling the warnings for now, or enabling them only for select releases. I understand that this increases the maintenance burden on unmaintained branches every time we update the sphinx binary in the docs buildtools. However, we missed this new broken link for almost a month now, which shows we don't look at successful docs build logs from the autobuilder.
Cheers,
Quentin
Quoted 90 lines · Quentin Schulz
Hi Richard, Michael,
Quoted 52 lines · Richard Purdie
Quoted 51 lines · Quentin Schulz
Hi Michael,
Quoted 32 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
This allows to switch to a more recent of Sphinx which will generate warnings with old versions of docs.
This way, it's not immediately necessary to patch
all such versions.This commit reverts
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D8273124feb9da2ffe93fcee7c4529d5597e1684a&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=9u5-2R_NLEQy5w0pFgklKIUQnAvVLuHX1ASaeEBBJJ4&e=
which originally reverted
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D931d409b255a85f2217ca093d8391a678ce00ddb&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=bTED2gTptfT6bSvLayy3fEpQJyUdbo5gLlt7ZGKkD1c&e=Signed-off-by Michael Opdenacker <[email protected]>--- scripts/run-docs-build | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/run-docs-build +1
-1@@ -63,7 +63,7 @@ for branch in 1.46 $(git branch --remote --contains "$first_sphinx_commit" --for git checkout $branch git checkout master releases.rst make clean - make publish + SPHINXOPTS="-j auto" make publish if [ "$branch" = "master-next" ]; then branch="next"scripts/run-docs-build for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- · line 140
Quoted 6 lines
scripts/run-docs-build +1
-1@@ -136,7 +136,7 @@ for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- fi make clean - make publish + SPHINXOPTS="-j auto" make publishWhat about doing this for all branches except master? To have at least some checks and not completely disable the warnings.
I'm a bit afraid we'll just not care about warnings anymore since they won't fail the autobuilder anymore. I also understand it's not really sustainable to leave them on for old docs since they won't be maintained at one point in time but we still very mnuch would like to be able to build them.
Quoted 5 lines
Quoted 1 line
Not sure what's the best solution here right now unfortunately :/
Enabling them for master could be a compromise, I'd take such a patch (Michael is away for a while).
Some warnings are actually valid. Such is the case for the one that warranted
https://git.yoctoproject.org/yocto-docs/commit/?id=9a797dedf6708da3e7ce789c5c8735e5d891cde4.
The issue is that we build the docs from old versions with the same version of sphinx. Therefore, this patch fixes the issue in master but should also be backported to all other impacted versions, even the unmaintained ones. See
https://docs.yoctoproject.org/dunfell/dev-manual/dev-manual-common-tasks.html#recipe-syntax,
instead of a link we now have a path between quotes.There are two ways to fix that one warning:
- add intersphinx_disabled_reftypes=[] inconf.pymanually from the
run-docs-build script, c.f.
https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
- patch all (tagged and branch) releases from 3.2 to current master inscripts/docs-build-patches,I prefer the second option because it feels less hacky, but that means MANY times the same file added to docs-build-patches directory.
The same could be done for the patch I just sent for yocto-docs to use the %s substitution characters for the cve extlinks to fix a warning. We could just apply this patch to affected releases (kirkstone-4.0.1 tag + kirkstone branch). I could technically request a backport to yocto-docs kirkstone branch, the only thing I don't like is bumping the min version requirement for sphinx for a release that was already released, but if that's okay with you, we could avoid having to add patches in the autobuilder for every new tagged release of kirkstone.
Quoted 6 lines
I'm honestly not sure there's a lot of benefit in disabling the warnings for now, or enabling them only for select releases. I understand that this increases the maintenance burden on unmaintained branches every time we update the sphinx binary in the docs buildtools. However, we missed this new broken link for almost a month now, which shows we don't look at successful docs build logs from the autobuilder.
Perhaps it is time we split the master build from the stable releases and used different buildtools tarballs for them?
That has it's own set of challenges of course too.
Cheers,
Richard
Richard, Quentin,
Quoted 94 lines · Richard Purdie
Quoted 87 lines · Quentin Schulz
Hi Richard, Michael,
Quoted 51 lines · Richard Purdie
Quoted 50 lines · Quentin Schulz
Hi Michael,
Quoted 32 lines · Michael Opdenacker via lists.yoctoproject.org
From: Michael Opdenacker <[email protected]>
This allows to switch to a more recent of Sphinx which will generate warnings with old versions of docs.
This way, it's not immediately necessary to patch
all such versions.This commit reverts
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D8273124feb9da2ffe93fcee7c4529d5597e1684a&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=9u5-2R_NLEQy5w0pFgklKIUQnAvVLuHX1ASaeEBBJJ4&e=
which originally reverted
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.yoctoproject.org_yocto-2Dautobuilder-2Dhelper_commit_-3Fid-3D931d409b255a85f2217ca093d8391a678ce00ddb&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=je4C362aUVxZ2rdozdrQVTgzhi9iRYrxNfYtH5LHkXdlsay9SEphJ_ekBm4830_n&s=bTED2gTptfT6bSvLayy3fEpQJyUdbo5gLlt7ZGKkD1c&e=Signed-off-by Michael Opdenacker <[email protected]>--- scripts/run-docs-build | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)scripts/run-docs-build +1
-1@@ -63,7 +63,7 @@ for branch in 1.46 $(git branch --remote --contains "$first_sphinx_commit" --for git checkout $branch git checkout master releases.rst make clean - make publish + SPHINXOPTS="-j auto" make publish if [ "$branch" = "master-next" ]; then branch="next"scripts/run-docs-build for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- · line 140
Quoted 6 lines
scripts/run-docs-build +1
-1@@ -136,7 +136,7 @@ for branch in dunfell $(git branch --remote --contains "$first_sphinx_commit" -- fi make clean - make publish + SPHINXOPTS="-j auto" make publishWhat about doing this for all branches except master? To have at least some checks and not completely disable the warnings.
I'm a bit afraid we'll just not care about warnings anymore since they won't fail the autobuilder anymore. I also understand it's not really sustainable to leave them on for old docs since they won't be maintained at one point in time but we still very mnuch would like to be able to build them.
Quoted 4 lines
Quoted 1 line
Not sure what's the best solution here right now unfortunately :/
Enabling them for master could be a compromise, I'd take such a patch (Michael is away for a while).
Some warnings are actually valid. Such is the case for the one that warranted
https://git.yoctoproject.org/yocto-docs/commit/?id=9a797dedf6708da3e7ce789c5c8735e5d891cde4.
The issue is that we build the docs from old versions with the same version of sphinx. Therefore, this patch fixes the issue in master but should also be backported to all other impacted versions, even the unmaintained ones. See
https://docs.yoctoproject.org/dunfell/dev-manual/dev-manual-common-tasks.html#recipe-syntax,
instead of a link we now have a path between quotes.There are two ways to fix that one warning:
- add intersphinx_disabled_reftypes=[] inconf.pymanually from the
run-docs-build script, c.f.
https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
- patch all (tagged and branch) releases from 3.2 to current master inscripts/docs-build-patches,I prefer the second option because it feels less hacky, but that means MANY times the same file added to docs-build-patches directory.
The same could be done for the patch I just sent for yocto-docs to use the %s substitution characters for the cve extlinks to fix a warning. We could just apply this patch to affected releases (kirkstone-4.0.1 tag + kirkstone branch). I could technically request a backport to yocto-docs kirkstone branch, the only thing I don't like is bumping the min version requirement for sphinx for a release that was already released, but if that's okay with you, we could avoid having to add patches in the autobuilder for every new tagged release of kirkstone.
Quoted 6 lines
I'm honestly not sure there's a lot of benefit in disabling the warnings for now, or enabling them only for select releases. I understand that this increases the maintenance burden on unmaintained branches every time we update the sphinx binary in the docs buildtools. However, we missed this new broken link for almost a month now, which shows we don't look at successful docs build logs from the autobuilder.
Quoted 4 lines
Perhaps it is time we split the master build from the stable releases and used different buildtools tarballs for them?
That has it's own set of challenges of course too.
I'd vote for such a solution, as it would allow to move on to newer versions of Sphinx without breaking existing documentation, causing a lot of extra work that's distracting us from working on the current docs.
Cheers
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com