Skip to content

Conversation

@nwager
Copy link
Contributor

@nwager nwager commented Dec 10, 2024

Closes #11
The test-kernel-in-proposed doc needs a signoff after some edits. All the changes and fixes to my initial writeup look good. There were just a couple more details I wanted to add.

@nwager nwager requested a review from AnneCYH as a code owner December 10, 2024 07:50
The one-line deb source format for non-x86 on pre-noble systems
mistakenly mentions /etc/apt/sources.list.d/ when the modification sould
be made to /etc/apt/sources.list.

Signed-off-by: Noah Wager <[email protected]>
Kernels can usually be installed either by directly installing the
ABI-named linux-image package or by installing the flavour-named
metapackage. Show both options.

Also clarify that specifying the debian version is only for
metapackages.

Signed-off-by: Noah Wager <[email protected]>
Copy link

@khbecker khbecker left a comment

Choose a reason for hiding this comment

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

looks good


```{code-block} none
sudo apt install linux-<flavour>
sudo apt install linux-<flavour> # install kernel metapackage
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hi @nwager , thanks for the additional details.
For the Ubuntu style guide, we don't encourage comments in the code block.
https://docs.ubuntu.com/styleguide/en/#code-examples-in-documentation

```

Then install the kernel as per usual. If the kernel version in -proposed is the
highest in any pocket, install it by running:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hi @nwager , i propose to change the structure a little in this section

  1. It would help to briefly indicate why you would choose to install the metapackage vs ABI-named image
  2. For your original content, I think if you install the kernel via ABI-named image, the "kernel version being the highest in the proposed pocket" is not relevant I think since you specify the actual version.

This is my suggested edit; please do review & adjust as needed.

First, update the sources cache:

```{code-block} none
sudo apt update
```

Then proceed to install the kernel using either a metapackage or a specific
ABI-named image.

### Install via kernel metapackage

Use this approach if you want to receives automatic updates for the latest
version of the kernel in that series.

If the kernel version in -proposed is the highest in any pocket, run:

```{code-block} none
sudo apt install linux-<flavour>
```

If you want a specific (earlier) version of a metapackage, include the version
in the command:

```{code-block} none
sudo apt install linux-<flavour>=<version>
```

### Install via ABI-named kernel image

Use this method to install a specific kernel version without being tied to the
kernel series metapackage.

```{code-block} none
sudo apt install linux-image-<version>
```

Thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, it makes more sense when things aren't haphazardly lumped together. Added this change pretty much verbatim in the recent commit e5b6767

Copy link
Collaborator

@AnneCYH AnneCYH left a comment

Choose a reason for hiding this comment

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

Hey @nwager , thanks for the update!

generally the changes look good and the additional details are helpful.

I have suggested some structural changes to improve the clarity of some sections; comments left for your consideration.

Thanks!

@AnneCYH
Copy link
Collaborator

AnneCYH commented Dec 11, 2024

Hi @nwager , todo after the PR is merged

  • Reference the RTD page from Ubuntu Wiki (suggest a "Related topics" section at the end with this kernel-docs page)

HTML output: https://canonical-kernel-docs.readthedocs-hosted.com/en/latest/how-to/testing-verification/test-kernel-in-proposed/

nwager and others added 2 commits December 12, 2024 09:09
Since kernels can be installed via metapackages or directly with
ABI-named packages, instead of lumping these steps in one block, split
the various options into their own subsections. This briefly notes the
differences and clarifies the steps to install the various packages.

Signed-off-by: Noah Wager <[email protected]>
@AnneCYH AnneCYH self-requested a review December 13, 2024 01:15
Copy link
Collaborator

@AnneCYH AnneCYH left a comment

Choose a reason for hiding this comment

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

looks good; i'll go ahead and squash + merge, thanks for the effort @nwager !

@AnneCYH AnneCYH merged commit 7720ef8 into canonical:main Dec 13, 2024
3 of 4 checks passed
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.

Review updates for how to test kernels in proposed guide

3 participants