build.7: Explain packaging a custom kernel
ClosedPublic
Actions

Authored by ziaee on Wed, Apr 1, 3:50 PM.

Details

Reviewers

None

Group Reviewers

pkgbase
manpages
docs
releng

Commits

rG7bb347ccc774: build.7: Explain packaging a custom kernel
rG1bcd2e2f8311: build.7: Explain packaging a custom kernel

Summary

MFC after: 3 days (to 15.1, right?)
Reported by: ivy
Requested by: vermaden

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

ziaee created this revision.Wed, Apr 1, 3:50 PM

Herald added a subscriber: imp. · View Herald TranscriptWed, Apr 1, 3:50 PM

Harbormaster completed remote builds in B71909: Diff 174745.Wed, Apr 1, 3:50 PM

ziaee requested review of this revision.Wed, Apr 1, 3:50 PM

ziaee added a parent revision: D54079: build.7: Improve make delete-old example.Wed, Apr 1, 4:00 PM

This LGTM but would like to hear @ivy's thoughts, given the Reported by

i didn't report this, but i do think we should document it. about MFC, nothing changed here between 15.0 and 15.1, so it would be best if we can get it in prior to the 15.1 release.

i think we also need to document the behaviour of building multiple kernels in KERNCONF, which is:

the first kernel listed in KERNCONF installs to /boot/kernel;
all remaining kernels install to /boot/kernel.NAME.

for example, if KERNCONF="FOO BAR BAZ" then three packages are generated:

FreeBSD-kernel-foo installs to /boot/kernel
FreeBSD-kernel-bar installs to /boot/kernel.BAR
FreeBSD-kernel-baz installs to /boot/kernel.BAZ

the user needs to set kernel= in /boot/loader.conf to select the correct non-default kernel.

(this behaviour will probably change in the future, but not in 15.x.)

share/man/man7/build.7
1069	that won't work, you have to build world and kernel before running update-packages. this is a limitation i'd like to lift (there was another thread about this on the list recently) but for now, that's how it is.

markmi_dsl-only.net added a subscriber: markmi_dsl-only.net.Wed, Apr 1, 6:12 PM

markmi_dsl-only.net added inline comments.

share/man/man7/build.7
1069	To be explicit: Does that mean that kernel-toolchain before buildkernel is insufficient for this type of context? If so, that might need to be explicitly mention.

ivy added inline comments.Wed, Apr 1, 7:10 PM

share/man/man7/build.7
1069	update-packages requires both world and kernel to be built first... that would implicitly include any required toolchains. if you don't do that, it will fail, probably with an unhelpful error message. (at least, i think that's still the case... it's possible you might end up with a repository containing only a kernel package, but that's almost certainly not what you want. but i don't think that's how it works. someone could test it...)

rebase due to addressing feedback in previous revision.

i didn't report this

i got this information from your mail on the pkgbase list, iiuc im supposed to then credit you with reported by.

i think we also need to document the behaviour of building multiple kernels in KERNCONF

agree. i think we should put that in the KERNCONF entry, im going to attempt it in a subsequent revision.

Harbormaster completed remote builds in B72002: Diff 174980.Mon, Apr 6, 4:41 PM

add releng because the build is also relevant to them

ziaee added a child revision: D56281: build.7: Explain specifying multiple KERNCONFs.Mon, Apr 6, 4:45 PM

Ping

my comment about running update-packages without running buildkernel is still open, i don't think we should recommend that people do this (and i'm not sure it even works).

add buildworld and split out update-packages; forgot about that, sorry.

Harbormaster completed remote builds in B72186: Diff 175464.Mon, Apr 13, 9:59 PM

guest-patmaddox added a subscriber: guest-patmaddox.Wed, Apr 15, 6:49 PM

Is this ready?

I am committing this due to feedback timeout. If we want to improve this more, I am absolutely happy to do so, but this is 1. a needed bugfix and 2. obstructing other work.