Skip to contentSkip to conversation

docs/support-matrix: Gross bodge to unbreak docs rendering

RFC PATCH Superseded Andrew Cooper 3 participants 5 messages Jun 4, 2020 – Jun 5, 2020

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 docs/support-matrix: Gross bodge to unbreak docs rendering

The cronjob which renders https://xenbits.xen.org/docs/ has been broken for a while. commitish_version() pulls an old version of xen/Makefile out of history, and uses the xenversion rule.

Currently, this fails with:

tmp.support-matrix.xen.make:130: scripts/Kbuild.include: No such file or directory

which is because the Makefile legitimately references Kbuild.include with a relative rather than absolute path.

Rearrange $CWD of the make rune to be in xen/

---
CC: George Dunlap <[email protected]>
CC: Ian Jackson <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Konrad Rzeszutek Wilk <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Wei Liu <[email protected]>
CC: Julien Grall <[email protected]>
CC: Anthony PERARD <[email protected]>
CC: Paul Durrant <[email protected]>

This is obviously not a proper fix. It will break in an unfixable way if we ever delete a file from the xen/ build system.

I don't think pulling a makefile out of history and expecting it to work in the current working tree is a reasonable expectation.

---
 docs/support-matrix-generate | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
docs/support-matrix-generate +2 -2
index a3d93321f1..2a1c3fad57 100755
@@ -102,8 +102,8 @@ commitish_version () {
     esac
 
     git cat-file blob "$commitish:$versionfile" >"$tmp_versionfile"
-    version=$(make --no-print-directory -C docs \
-                   -f "${tmp_versionfile#docs/}" xenversion)
+    version=$(make --no-print-directory -C xen \
+                   -f "../${tmp_versionfile}" xenversion)
     case "$version" in
         *.*.*) version="${version%.*}" ;;
     esac
Signature · 1 line
2.11.0
#1 lore raw
Quoted 25 lines · Andrew Cooper

The cronjob which renders https://xenbits.xen.org/docs/ has been broken for a while. commitish_version() pulls an old version of xen/Makefile out of history, and uses the xenversion rule.

Currently, this fails with:

tmp.support-matrix.xen.make:130: scripts/Kbuild.include: No such file or directory

which is because the Makefile legitimately references Kbuild.include with a relative rather than absolute path.

Rearrange $CWD of the make rune to be in xen/

---
CC: George Dunlap <[email protected]>
CC: Ian Jackson <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Konrad Rzeszutek Wilk <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Wei Liu <[email protected]>
CC: Julien Grall <[email protected]>
CC: Anthony PERARD <[email protected]>
CC: Paul Durrant <[email protected]>

Quoted 5 lines

This is obviously not a proper fix. It will break in an unfixable way if we ever delete a file from the xen/ build system.

I don't think pulling a makefile out of history and expecting it to work in the current working tree is a reasonable expectation.

Actually - it occurs to me that we only want the major and minor number.

I think it is reasonable to expect that those will always be plain numbers, and we can grep them directly out of the file, rather than feeding the thing to make.

Thoughts?

~Andrew

Quoted 19 lines
---
 docs/support-matrix-generate | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
docs/support-matrix-generate +2 -2
index a3d93321f1..2a1c3fad57 100755
@@ -102,8 +102,8 @@ commitish_version () {
     esac
 
     git cat-file blob "$commitish:$versionfile" >"$tmp_versionfile"
-    version=$(make --no-print-directory -C docs \
-                   -f "${tmp_versionfile#docs/}" xenversion)
+    version=$(make --no-print-directory -C xen \
+                   -f "../${tmp_versionfile}" xenversion)
     case "$version" in
         *.*.*) version="${version%.*}" ;;
     esac
#2 lore raw
Quoted 32 lines · Andrew Cooper
Quoted 25 lines · Andrew Cooper

The cronjob which renders https://xenbits.xen.org/docs/ has been broken for a while. commitish_version() pulls an old version of xen/Makefile out of history, and uses the xenversion rule.

Currently, this fails with:

tmp.support-matrix.xen.make:130: scripts/Kbuild.include: No such file or directory

which is because the Makefile legitimately references Kbuild.include with a relative rather than absolute path.

Rearrange $CWD of the make rune to be in xen/

---
CC: George Dunlap <[email protected]>
CC: Ian Jackson <[email protected]>
CC: Jan Beulich <[email protected]>
CC: Konrad Rzeszutek Wilk <[email protected]>
CC: Stefano Stabellini <[email protected]>
CC: Wei Liu <[email protected]>
CC: Julien Grall <[email protected]>
CC: Anthony PERARD <[email protected]>
CC: Paul Durrant <[email protected]>

Quoted 5 lines

This is obviously not a proper fix. It will break in an unfixable way if we ever delete a file from the xen/ build system.

I don't think pulling a makefile out of history and expecting it to work in the current working tree is a reasonable expectation.

Quoted 7 lines

Actually - it occurs to me that we only want the major and minor number.

I think it is reasonable to expect that those will always be plain numbers, and we can grep them directly out of the file, rather than feeding the thing to make.

Thoughts?

I was about to ask why we don't do that.

Jan

#3 lore raw

Jan Beulich writes ("Re: [PATCH for-4.14 RFC] docs/support-matrix: Gross bodge to unbreak docs rendering"):

Quoted 1 line

I was about to ask why we don't do that.

When I wrote the code in question, I was afraid that this makefile would change in a way that would break that approach. Unfortunately it seems I guessed wrong and instead it changed in a way that broke the approach I took instead.

So +1 to this.

Ian.

#4 lore raw
In reply to Andrew Cooper

Andrew Cooper writes ("Re: [PATCH for-4.14 RFC] docs/support-matrix: Gross bodge to unbreak docs rendering"):

Quoted 7 lines

Actually - it occurs to me that we only want the major and minor number.

I think it is reasonable to expect that those will always be plain numbers, and we can grep them directly out of the file, rather than feeding the thing to make.

Thoughts?

I would be happy with that approach.

The alternative would be to move these settings into a separate makefile where we promise that support-matrix-generate's assumption (that you can make -f just-that-file and get sensible behaviour) is going to be kept true.

Perhaps I should apologise for perpetrating the existing now-broken code. But there was no less insane official way of getting the version out without checking out the whole tree...

Ian.