diff mbox series

[1/2] doc/features: describe distribution feature pni-name

Message ID 9288e40f901792887ac98417ae8c89fcc2f23a0d.1725018000.git.joerg.sommer@navimatix.de
State New
Headers show
Series [1/2] doc/features: describe distribution feature pni-name | expand

Commit Message

Jörg Sommer Aug. 30, 2024, 11:40 a.m. UTC
From: Jörg Sommer <joerg.sommer@navimatix.de>

Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
---
 documentation/ref-manual/features.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Quentin Schulz Aug. 30, 2024, 12:19 p.m. UTC | #1
Hi Jörg,

On 8/30/24 1:40 PM, Jörg Sommer via lists.yoctoproject.org wrote:
> From: Jörg Sommer <joerg.sommer@navimatix.de>
> 
> Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
> ---
>   documentation/ref-manual/features.rst | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
> index 2ea946b31d..81f09f59d8 100644
> --- a/documentation/ref-manual/features.rst
> +++ b/documentation/ref-manual/features.rst
> @@ -197,6 +197,10 @@ metadata, as extra layers can define their own:
>   
>   -  *pcmcia:* Include PCMCIA/CompactFlash support.
>   
> +-  *pni-names:* Enable generation of persistent network interface names,
> +   i.e. it's tried hard to get the same but unique names for the network
> +   interfaces even after a reinstall.
> +

I'm a bit bothered by "it's tried hard to get". I could suggest:

"""
the system tries hard to have the same but unique names for the network 
interfaces even after a reinstall.
"""

Whatever works best, not sure it's any better. In any case,

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

@Alex: A `git log -S pni-names` in poky returns commits that started in 
scarthgap, and all of them are available in scarthgap, therefore I 
believe this matches the requirements for backporting to scarthgap too.

Thanks!
Quentin
Jörg Sommer Aug. 30, 2024, 12:26 p.m. UTC | #2
Quentin Schulz schrieb am Fr 30. Aug, 14:19 (GMT):
> On 8/30/24 1:40 PM, Jörg Sommer via lists.yoctoproject.org wrote:
> > From: Jörg Sommer <joerg.sommer@navimatix.de>
> > 
> > Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de>
> > ---
> >   documentation/ref-manual/features.rst | 4 ++++
> >   1 file changed, 4 insertions(+)
> > 
> > diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
> > index 2ea946b31d..81f09f59d8 100644
> > --- a/documentation/ref-manual/features.rst
> > +++ b/documentation/ref-manual/features.rst
> > @@ -197,6 +197,10 @@ metadata, as extra layers can define their own:
> >   -  *pcmcia:* Include PCMCIA/CompactFlash support.
> > +-  *pni-names:* Enable generation of persistent network interface names,
> > +   i.e. it's tried hard to get the same but unique names for the network
> > +   interfaces even after a reinstall.
> > +
> 
> I'm a bit bothered by "it's tried hard to get". I could suggest:
> 
> """
> the system tries hard to have the same but unique names for the network
> interfaces even after a reinstall.
> """
> 
> Whatever works best, not sure it's any better.

I'm open for any suggestions. I'm not a native speaker and better in writing
code than texts.

I'll send a v2 for this patch.

--
diff mbox series

Patch

diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index 2ea946b31d..81f09f59d8 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -197,6 +197,10 @@  metadata, as extra layers can define their own:
 
 -  *pcmcia:* Include PCMCIA/CompactFlash support.
 
+-  *pni-names:* Enable generation of persistent network interface names,
+   i.e. it's tried hard to get the same but unique names for the network
+   interfaces even after a reinstall.
+
 -  *polkit:* Include :wikipedia:`Polkit <Polkit>` support.
 
 -  *ppp:* Include PPP dialup support.