Skip to content

Conversation

saiarcot895
Copy link
Contributor

Update the repo's README.md file to cover the current policies for accepting kernel patches.

Also update the CODEOWNERS file with the current team name, so that maintainers get notified of PRs.

@saiarcot895 saiarcot895 requested a review from lguohan May 17, 2023 00:33
@saiarcot895 saiarcot895 marked this pull request as draft May 17, 2023 00:36
@saiarcot895
Copy link
Contributor Author

Patches will be moved into the folders in a later commit as part of this PR.


## Description
This repository contains the scripts and patches to build the kernel for SONiC. SONiC uses the same kernel for all platforms. We prefer to out-of-tree kernel platform modules. We accept kernel patches on following conditions:
This repository contains the scripts and patches to build the kernel for SONiC. SONiC uses the same kernel for all amd64 platforms (armhf and arm64 platforms currently have platform-specific kernels). We accept kernel patches on following conditions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’d add one dot/period before after platforms before starting the ()., and move the dot/period at the end inside the (), as it’s a full sentence.

- Please include the original upstream commit ID and message in the patch or the PR description. This allows the maintainer to remove upstream patches during the kernel upgrade.
- Those patches will be upstreamed or are in the process of being upstreamed.
- If being upstreamed, please include a link to the mail thread in the patch or PR description.
- Those patches don't make sense to be upstreamed, either because they're applicable only within SONiC or they would break some general use case.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make that a separate commit with a separate discussion. In my opinion, all code needs to be upstreamed. Maybe add, that there needs to be a convincing explanation, why code cannot be upstreamed.

lguohan
lguohan previously approved these changes Jun 14, 2024
Patches will be moved into separate folders in a later commit.

Signed-off-by: Saikrishna Arcot <[email protected]>
Signed-off-by: Saikrishna Arcot <[email protected]>
Copy link
Contributor

@paulmenzel paulmenzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for picking this up again. I would split the merge/pull request into just documentation update, and then another one for the policy update.

@saiarcot895
Copy link
Contributor Author

Is there a clear distinction between the two? Perhaps the formatting changes done in the second half of the document as a separate PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants