SRU: Add crash and makedumpfile SRU exception policy#474
SRU: Add crash and makedumpfile SRU exception policy#474maskedarray wants to merge 2 commits intoubuntu:mainfrom
Conversation
maskedarray
requested review from
RAOF,
basak,
enr0n,
julian-klode,
panlinux and
tjaalton
as code owners
basak
left a comment
basak
left a comment
There was a problem hiding this comment.
This isn't a full review but here a couple of early comments I hope are useful.
Signed-off-by: Abdur Rahman <abdur.rahman@canonical.com>
|
Sorry, I'm missing something. Where is the test plan? What are the steps that a tester is supposed to follow? |
I realized that it is somewhat scattered. I will consolidate it in one place. |
Signed-off-by: Abdur Rahman <abdur.rahman@canonical.com>
|
@basak I have added a list of steps to follow in order to test a new version of the packages. Thank you for pointing that out. |
enr0n
left a comment
enr0n
left a comment
There was a problem hiding this comment.
Overall, I think this is looking good. I think this exception would be beneficial to users, and although the upstream projects do not very clearly describe a compatibility promise, I think there is evidence that this will generally be safe to do.
I did leave some comments about clarity, structure, typos, etc.
|
|
||
| Upstream resources: | ||
|
|
||
| - `Porject page <https://github.com/makedumpfile/makedumpfile>`_ |
| Rationale for the exception | ||
| --------------------------- | ||
|
|
||
| Crash is extremely helpful for analysis and RCA of kernel issues. |
There was a problem hiding this comment.
suggestion: "root cause analysis" is more readable than "RCA", especially if this is the only use
| versions. | ||
|
|
||
| Makedumpfile is responsible for generating the compressed memory dump | ||
| from /proc/vmcore which can be consumed by tools such as crash[1]. The |
There was a problem hiding this comment.
suggestion: please make hyperlinks, rather than [1], to be consistent with the rest of the document. Then the "References" section below can be removed.
| makedumpfile are necessary to ensure proper functionality. | ||
|
|
||
| Furthermore, the release of both of these projects are disconnected from | ||
| upstream and the Ubuntu release cycles. It is possible the the upstream |
There was a problem hiding this comment.
Can you clarify which project is "upstream" in this sentence? The kernel?
Also, typo: "the the" -> "the"
| Furthermore, the release of both of these projects are disconnected from | ||
| upstream and the Ubuntu release cycles. It is possible the the upstream | ||
| projects have the right support for a new kernel release, but there may | ||
| not be a release for some time. In such situations, SRU of specific | ||
| patches from the upstream crash and makedumpfile projects may be | ||
| required. |
There was a problem hiding this comment.
I think this paragraph in general needs to be clarified.
It sounds like you are saying something along the lines of "sometimes, individual patches from upstream crash or upstream makedumpfile are required to support a stable Ubuntu release". If that's the case, I am not sure that needs to be described in this document. That sounds more like a typical SRU.
If I am wrong, please try to re-word this paragraph to make it clear what is exceptional about it.
| leave out specific flavors and other derivative kernels like | ||
| *linux-aws*, *linux-azure*, etc. Kernel team has integrated kdump | ||
| testing within their SRU Regression Testing suite and hence would be | ||
| running this test against all of the prepared kernel once per kernel SRU |
| Checklist | ||
| ~~~~~~~~~ | ||
| - Ensure crash can open dumps for the GA kernel on supported architectures | ||
| - Ensure crash can open dumps for the HWE kernel on supported architectures | ||
| - Attach or link to logs confirming above tests | ||
| - Update the list of previous crash updates under this SRU Exception below |
There was a problem hiding this comment.
This feels like it belongs in the "Test Plan" section.
| The test plan from | ||
| `CrashMakedumpfileUpdates <https://github.com/ubuntu/ubuntu-project-docs/blob/main/docs/SRU/reference/exception-CrashMakedumpfile-Updates.rst>`_ | ||
| was followed. Attached are console logs for each covered kernel version | ||
| and architecture. |
There was a problem hiding this comment.
This is written in the past tense, but when we review SRUs, we usually expect the test plan to describe what you are going to do do when the package is in -proposed. Hence, I think it would be more clear if the steps from the above "SRU process" section were moved here, along with the "Regression testing" notes.
If you intend to do all of this testing with a PPA beforehand, please clarify that, but note that the testing should be done with -proposed as well.
4 participants
Description
This PR introduces SRU exception policy for Crash and Makedumpfile packages to support proper functionality of these packages against new kernel releases.
Checklist
Thank you for reviewing this document!