sphinx/test-outcomes: make test target mandatory#2470
Conversation
jyn514
left a comment
jyn514
left a comment
There was a problem hiding this comment.
this is lovely, thank you :)
| * ``library_compiletest_target`` (required): the target tuple of the target | ||
| used to run library and compiler tests. For targets that have a standard | ||
| library this is the same tuple as the compilation targets; for targets | ||
| without a standard library it will be a facade target |
There was a problem hiding this comment.
i find the name of this option hard to understand -- if you don't like the "bare metal" part, can we just call it "tested_target" to match render_template.py?
There was a problem hiding this comment.
if I'm modifying the target (.rst) pages in the qualification report and I don't know that the sphinx extensions have docs (past me says 🙋♂️) and I see tested_target I'll probably just duplicate the target field. if the name conveys the idea that the target is used to run the compiler and library tests then that should give me some pause "probably can't run compiler tests on a -none- target so I can't duplicate the aarch64-unknown-none that I see in :target:"
bare_metal_target I find even more confusing. if :target: is x86_64-unknown-linux-gnu then I would probably set :bare_metal_target: to x86_64-unknown-none or something.
I don't know that the sphinx extensions have docs
IMO, if you want documentation to be read you need to put in front of people's face at all times, and not tuck it away in some drawer. Hence, I'd like to have self-documenting variable names.
There was a problem hiding this comment.
can we name it tested_target_with_std, then? library_compiletest_target reads to me like something that's going to passed to x test <...>, not a --target value at all.
jyn514
added
the
waiting-on-author
8c8f551 to
e7ab79c
Compare
The rationale is that forgetting to set it loads the test outcomes from the
no-std ("bare metal") target which then results in target page in the
qualification report without test outcomes even when the data is available for
the test target
The name is also changed to "library compiletest target" to better reflect that
it is the target used to run those tests which can't run on a no-std target.
otherwise the Sphinx extension will only produce an inescrutable error in one of the final CI steps (linux-docs)
e7ab79c to
8a12db4
Compare
japaric
added
waiting-on-review
and removed
waiting-on-author
2470: sphinx/test-outcomes: make test target mandatory r=Urhengulas a=japaric see commit message for rationale. also check the qualification report target pages in tidy 2476: No RHIVOS in main safety man r=Urhengulas a=Hoverbear #2388 touched this so we touch it again. RHIVOS should be in the safety manual for RHIVOS, not main one. Co-authored-by: Jorge Aparicio <[email protected]> Co-authored-by: Ana Hobden <[email protected]>
|
Build failed (retrying...):
|
|
Build succeeded:
|
github-actions
Bot
added
backport:maybe
3 participants
see commit message for rationale. also check the qualification report target pages in tidy