-
Notifications
You must be signed in to change notification settings - Fork 36
Migrate from ST4 to Apache Freemarker in keyext.proofmanagement #3621
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
base: main
Are you sure you want to change the base?
Conversation
On my branch |
Ah no, spoke too soon! Some things are still wrong in the report (filtering of messages, settings entries, CSS) ... |
ec40f21
to
38e2640
Compare
With f3459ad, the report is generated successfully w/o exception. Rebase required, before merge. |
locally not reproducible
In 1bbc18a on |
I did this on purpose. The format of a cumulative bar chart was misleading: If category "proven" is zero, it is hidden. Reporting should make the current state explicitly visible. |
I thought that the idea of this PR was to do only refactoring and rewriting from ST to Freemarker (as indicated in the description). I would prefer not mixing in functional changes, since the PR is already large enough and should only have one purpose. Also, in my opinion the "overview bar" in the report is good as is: The number of proofs in the bundle is split between "proven", "dependencies left", and "unproven", if either of these is 0, it is not displayed. In any case, I think the version on main is way easier to read than the one of this PR. |
You should not hide crucial information. The first time I looked at the report, I did not understand it. It was unclear whether the two categories showed meant something was ok or not. Only by showing "proven: 0", I understood that the category "dependencies left" symbolizes a not-good state. The problem of hiding information, especially on complex formats, could also result from an error in the output, e.g., the HTML could be corrupt. Printing zero values helps here for auditability. In the end, the report should be simple, convincing and trustworthy. I tried to get this right with your stacked bar chart, but failed to get a good look at low numbers. Also thought of drawing an SVG diagram. |
Related Issue
ST4 is blocking from module-info usage, see #3451.
This PR swaps ST4 against Apache Freemarker.
Type of pull request
Ensuring quality