CHANGELOG: document breaking change of runc update #4848
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marquiz
force-pushed
the
devel/changelog
branch
from
9be623a to
660f505
Compare
AkihiroSuda
approved these changes
Aug 11, 2025
lifubang
reviewed
Aug 12, 2025
cyphar
reviewed
Aug 12, 2025
CHANGELOG.md
Outdated
Comment on lines
12
to
14
| original container spec did not include linux.intelRdt. Without intelRdt in | ||
| the spec, no CLOS (resctrl group) is created for the container, so these | ||
| options cannot be properly applied. (#4827) |
There was a problem hiding this comment.
Since this is a breaking change entry in the changelog, it would be nice for this last sentence (explaining why the breaking change was necessary / that the original feature didn't work) to be a little bit longer.
Also, we tend to refer to the initial configuration as config.json directly in runc docs.
Something like
Suggested change
| original container spec did not include linux.intelRdt. Without intelRdt in | |
| the spec, no CLOS (resctrl group) is created for the container, so these | |
| options cannot be properly applied. (#4827) | |
| original `config.json` did not include `linux.intelRdt`. | |
| The reason for this change is that if `linux.intelRdt` is missing | |
| from `config.json` when the container was created, no CLOS (resctrl | |
| group) will be created, and so it is not possible to apply the | |
| updated options with `runc update`. | |
| Previously, runc would **FILL IN WITH PREVIOUS RUNC BEHAVIOUR AND | |
| HOW IT WAS BROKEN**. (#4827) |
(This also includes @lifubang's suggestion.)
There was a problem hiding this comment.
Updated, a slightly less verbose version
Co-authored-by: lfbzhm <[email protected]> Signed-off-by: Markus Lehtonen <[email protected]>
marquiz
force-pushed
the
devel/changelog
branch
from
660f505 to
562e5db
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.