integration-test, xtask: Move xtask run docs into README #741
Conversation
This moves the docs for downloading kernels into the integration-test README since it allows us to be more verbose. Instructions have been added for the use of Fedora kernels. The instructions for Debian kernels were amended to not download all the kernels, and to encourage targetted download of the one you care about. Signed-off-by: Dave Tucker <[email protected]>
✅ Deploy Preview for aya-rs-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @dave-tucker)
test/README.md line 46 at r1 (raw file):
```bash dpkg --fsys-tarfile test/.tmp/debian-kernels/arm64/linux-image-5.10.0-23-cloud-amd64-unsigned_5.10.179-3_amd64.deb | tar -C test/.tmp --wildcards --extract '*vmlinuz*' --file -
do some wrapping here?
xtask/src/run.rs line 29 at r1 (raw file):
/// The kernel images to use. /// /// You can download some images with:
we should keep something here, even if it points to the README. This text is printing when you run cargo xtask integration-test vm --help
There was a problem hiding this comment.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @dave-tucker)
test/README.md line 46 at r1 (raw file):
```bash dpkg --fsys-tarfile test/.tmp/debian-kernels/arm64/linux-image-5.10.0-23-cloud-amd64-unsigned_5.10.179-3_amd64.deb | tar -C test/.tmp --wildcards --extract '*vmlinuz*' --file -
can we keep the find | xargs thing in case the user downloaded multiple kernels? that also saves you from naming the kernel multiple times so it's easy to copy and paste the command.
test/README.md line 53 at r1 (raw file):
To download an image from the Fedora project: - Search for the kernel version you require on [Koji](https://koji.fedoraproject.org/koji/search?match=glob&type=build&terms=kernel-4*)
why 4-series kernels? is there an incantation that would allow me to download a bunch of kernels in one go?
test/README.md line 64 at r1 (raw file):
```bash rpm2cpio ./test/.tmp/fedora-kernels/x86_64/kernel-core-5.10.23-200.fc33.x86_64.rpm \
ditto, let's phrase this as a find | xargs pipeline to avoid naming the files more than once
xtask/src/run.rs line 31 at r1 (raw file):
/// You can download some images with: /// /// wget --accept-regex '.*/linux-image-[0-9\.-]+-cloud-.*-unsigned*' \
we should keep these fancy instructions somewhere - - it's a highly useful incantation if you want to grab a whole bunch of kernels at once.
|
@dave-tucker, this pull request is now in conflict and requires a rebase. |
There was a problem hiding this comment.
(Nothing to add on top of @tamird's comments, just requesting changes since I accidentally approved this instead of another PR in vscode 🤦♂️)
|
@dave-tucker, this pull request is now in conflict and requires a rebase. |
This moves the docs for downloading kernels into the integration-test README since it allows us to be more verbose.
Instructions have been added for the use of Fedora kernels.
The instructions for Debian kernels were amended to not download all the kernels, and to encourage targetted download of the one you care about.