Bug#991627: installation-guide: expand firmware-related documentation

[Holger Wansing <hwansing@mailbox.org>]

Hi,

Holger Wansing <hwansing@mailbox.org> wrote (Fri, 30 Jul 2021 09:11:13 +0200):
> > > I'm not very used to best practices when it comes to end-user doc in
> > > general and to the installation-guide package in general, so I'd be
> > > happy for other to build on those suggested changes, and amend/reword
> > > as required!
> > 
> > That's still true!
> 
> Don't know, if I am better in this respect, but here we go :-)

I forgot this one:


"Installing firmware packages is very likely to require enabling the
non-free section of the package archive. As of
&debian-gnu; 11.0, the
<command>isenkram-autoinstall-firmware</command> command does that by
creating a dedicated file
(<filename>/etc/apt/sources.list.d/isenkram-autoinstall-firmware.list</filename>),
pointing at a generic mirror."


I would add an additional "automatically" to make more clear, that adding
the sources.list.d file is done without user intervention:

"As of
&debian-gnu; 11.0, the
<command>isenkram-autoinstall-firmware</command> command does that automatically by
                                                                   ^^^^^^^^^^^^^
creating a dedicated file
(<filename>/etc/apt/sources.list.d/isenkram-autoinstall-firmware.list</filename>),
pointing at a generic mirror."


---------------------

And regarding your comment 
>  - Documenting what isenkram-autoinstall-firmware does means we should
>    check what happens for each major release, to keep up with the
>    current implementation. Doing that once every two years doesn't seem
>    unreasonable though.

Maybe we can add a 'what-to-check-before-next-stable-release' file for the
installation-guide somewhere, to make sure this does not get forgotten ...

I think there is such doc somewhere for other artefacts of releasing d-i?



Holger



-- 
Holger Wansing <hwansing@mailbox.org>
PGP-Fingerprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076