Skip to content

Conversation

@benjamin051000
Copy link

@benjamin051000 benjamin051000 commented Feb 4, 2025

This is a new how-to guide on respin cranks.

Link to built docs (also at the bottom in the "Checks"): https://canonical-kernel-docs--57.com.readthedocs.build/en/57/how-to/respin/

Signed-off-by: Benjamin Wheeler <[email protected]>
Copy link
Member

@nukelet nukelet left a comment

Choose a reason for hiding this comment

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

this is great, thanks for taking the time to write it! i left a small nit comment but otherwise it looks good to me

Signed-off-by: Benjamin Wheeler <[email protected]>
Signed-off-by: Benjamin Wheeler <[email protected]>
@benjamin051000 benjamin051000 marked this pull request as ready for review February 5, 2025 19:45
@benjamin051000
Copy link
Author

Content is finished at this point, please review and let me know what you think.

@benjamin051000 benjamin051000 changed the title WIP: Respin how-to guide Respin how-to guide Feb 5, 2025
Signed-off-by: Benjamin Wheeler <[email protected]>
Copy link
Author

@benjamin051000 benjamin051000 left a comment

Choose a reason for hiding this comment

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

My initial thoughts

Comment on lines +11 to +13
```{attention}
Only one person peforms this step. If you already have a Jira card, note the respin number in the card (see Note at the end of this step) and skip this step.
```
Copy link
Author

Choose a reason for hiding this comment

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

Is attention too harsh on the eyes? 🤷🏼‍♂️

Copy link

Choose a reason for hiding this comment

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

It does stand out, but I think that's ok.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would use Warning / Attention / Caution for something that you absolutely don't want someone to do without understanding the impact.

So in this case, if you DO create another Jira card, what happens?

Comment on lines +29 to +34
```{note}
Note the respin number, as it's used in subsequent steps.
The respin number is in the title of the Jira card in parentheses.
For example, "Re-spin (#8)" indicates the number is 8.
```
Copy link
Author

Choose a reason for hiding this comment

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

This is important to read, even if you were told to skip this section... How should we make that more clear? Maybe it's clear enough as-is.

Comment on lines +53 to +54
On Launchpad, mark the original tracking bug as a duplicate of the newly-created bug.
<!-- TODO screenshots of how to do this -->
Copy link
Author

Choose a reason for hiding this comment

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

It would be nice to have a screenshot of how to do this in launchpad, it's not obvious to newbies (myself).

Comment on lines +83 to +84
You may also be asked to modify the commit message.
<!--TODO elaborate?-->
Copy link
Author

Choose a reason for hiding this comment

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

Should we elaborate? Is there a standard/convention we generally follow?

Copy link
Member

@nukelet nukelet left a comment

Choose a reason for hiding this comment

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

the github review workflow is kind of unfamiliar to me so i ended up leaving comments before starting the review for good, but overall it looks good to me. most comments are just some relatively unimportant nits/observations


It is possible to make changes before the SRU cycle closes. This is a special version of a crank called a respin.

These are the steps to respin a kernel, with examples from a previous `2025.01.13` respin of the `noble:linux-gke` kernel due to a late-cycle decision to revert a patchset.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hey @benjamin051000 , i haven't finished reviewing this but a how-to shouldn't be too specific in terms of the scenarios described in the guide.
I would caution setting up this expectation by mentioning a specific cycle and kernel and reason for respin.

benjamin051000 and others added 8 commits February 7, 2025 10:04
Signed-off-by: Benjamin Wheeler <[email protected]>
Signed-off-by: Benjamin Wheeler <[email protected]>
Co-authored-by: AnneCYH <[email protected]>
Signed-off-by: Benjamin Wheeler <[email protected]>
Co-authored-by: AnneCYH <[email protected]>
Signed-off-by: Benjamin Wheeler <[email protected]>
Signed-off-by: Benjamin Wheeler <[email protected]>
@benjamin051000
Copy link
Author

Closing this as this is moving to an internal repo.

@benjamin051000 benjamin051000 deleted the howto-respin branch February 12, 2025 19:29
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.

8 participants