[pve-devel] [PATCH docs 1/3] boot: add new pve-efiboot-tool commands

[Thomas Lamprecht]

On 7/15/19 3:06 PM, Fabian Grünbichler wrote:
> looks good to me. @Thomas - do you want to fix this up when
> applying or should I send a v2?

Normally both is OK for me, but today I'd prefer a v2 :)

> 
> On Mon, Jul 15, 2019 at 02:36:25PM +0200, Aaron Lauterer wrote:
>> some thoughts from my side regarding readability:
>>
>> On 7/15/19 11:35 AM, Fabian Grünbichler wrote:
>>> to manage manually selected kernel list.
>>>
>>> Signed-off-by: Fabian Grünbichler <f.gruenbichler at proxmox.com>
>>> ---
>>> reflecting my last, not-yet-applied series for pve-kernel-meta
>>>
>>>   system-booting.adoc | 39 +++++++++++++++++++++++----------------
>>>   1 file changed, 23 insertions(+), 16 deletions(-)
>>>
>>> diff --git a/system-booting.adoc b/system-booting.adoc
>>> index 61b74df..c7f6534 100644
>>> --- a/system-booting.adoc
>>> +++ b/system-booting.adoc
>>> @@ -118,29 +118,36 @@ initrd   /EFI/proxmox/5.0.15-1-pve/initrd.img-5.0.15-1-pve
>>>   .Manually keeping a kernel bootable
>>>   Should you wish to add a certain kernel and initrd image to the list of
>>> -bootable kernels you need to:
>>> +bootable kernels you can use `pve-efiboot-tool kernel add`.
>>
>> skip the "you can" -> "bootable kernels use `pve-efiboot-tool kernel add`."
>>
>>> -* create a directory on the ESP (e.g. `/EFI/personalkernel`)
>>> -* copy the kernel and initrd image to that directory
>>> -* create a entry for this kernel in `/loader/entries/*.conf`
>>> +E.g., to add the kernel with ABI version `5.0.15-1-pve` to the list of kernels
>>> +to keep installed and synced to all ESPs, run the following:
>>
>> "For example run the following to add the kernel with ABI version
>> `5.0.15-1-pve` to the kernels that are installed and synced to all ESPs:"
>>
>> We want to avoid "E.g." as much as possible. I also tried to simplify the
>> sentence a bit.
>>
>>> -NOTE: do not use `/EFI/proxmox` as directory since all entries there can be
>>> -removed by `/etc/kernel/postinst.d/zz-pve-efiboot`
>>> +----
>>> +pve-efiboot-tool kernel add 5.0.15-1-pve
>>> +----
>>> +
>>> +`pve-efiboot-tool kernel list` will list all kernel versions currently selected
>>> +for booting:
>>> +
>>> +----
>>> +# pve-efiboot-tool kernel list
>>> +Manually selected kernels:
>>> +5.0.15-1-pve
>>> +
>>> +Automatically selected kernels:
>>> +5.0.12-1-pve
>>> +4.15.18-18-pve
>>> +----
>>> -Example (keeping kernel 5.0.15-1-pve and copying to an ESP mounted on
>>> -`/mnt/esp`):
>>> +To remove a kernel from the list of manually selected kernels, run
>>> +`pve-efiboot-tool remove`, e.g.:
>>
>> "Run `pve-efiboot-tool remove` to remove a kernel from the list of manually
>> selected kernels, for example:
>>
>>>   ----
>>> -mkdir /mnt/esp/EFI/preferred-kernel
>>> -cp /boot/initrd.img-5.0.15-1-pve /boot/vmlinuz-5.0.15-1-pve /mnt/esp/EFI/preferred-kernel
>>> -echo -n "title Preferred Kernel
>>> -version 5.0.15-1-pve
>>> -linux /mnt/esp/EFI/preferred-kernel/vmlinuz-5.0.15-1-pve
>>> -initrd /mnt/esp/EFI/preferred-kernel/initrd.img-5.0.15-1-pve
>>> -options " > /mnt/esp/loader/entries/preferred.conf
>>> -cat /etc/kernel/cmdline >> /mnt/esp/loader/entries/preferred.conf
>>> +pve-efiboot-tool kernel remove 5.0.15-1-pve
>>>   ----
>>> +
>>>   [[sysboot_systemd_boot_setup]]
>>>   .Setting up a new partition for use as synced ESP
>>>
>>