From: Jason McIntyre <jmc@kerhand.co.uk>
Subject: Re: dhcp6leased(8): document /var/db/dhcp6leased/uuid
To: tech@openbsd.org
Date: Tue, 29 Oct 2024 20:29:31 +0000

On Tue, Oct 29, 2024 at 08:14:02PM +0000, Klemens Nanni wrote:
> 29.10.2024 23:06, Florian Obser ??????????:
> > OK?
> 
> OK kn with the first comment fixed;  on the second I'd defer to jmc.
> 
> > 
> > diff --git dhcp6leased.8 dhcp6leased.8
> > index 762fa4344db..c26e3e040e5 100644
> > --- dhcp6leased.8
> > +++ dhcp6leased.8
> > @@ -31,6 +31,15 @@ is an IPv6 dynamic host configuration protocol (DHCPv6) daemon for clients.
> >  It requests IPv6 prefix delegations from DHCPv6 servers for assignment
> >  to downstream interfaces.
> >  .Pp
> > +DHCPv6 clients are identified by DHCPv6 Unique Identifiers (DUID).
> > +.Nm
> > +uses a DUID based on a random Universally Unique Identifier
> > +(UUID).
> > +The DUID is stored in
> > +.Pa /var/db/dhcp6leased/uuid
> 
> Needs a trailing dot (and space between path and dot).
> 
> > +If the file does not exist or the UUID is not readable a new, random
> > +UUID is generated.
> That comma threw me off, "... readable, a new random ..." would be clearer, imho.
> 

so i didn;t comment on this because there's a number of places you can
stick commas here.

there should really be commas after "readable" and "new", but that is
heavy on the commas:

	...is not readable, a new, random UUID is generated.
	...is not readable, a new, random, UUID is generated.

or even heavier:

	...does not exist, or the UUID is not readable, a new, random, UUID is generated.

your suggestion:

	...is not readable, a new random UUID is generated.

"new random" looks wrong to me.

or try and cheat:

	...is not readable, a new (random) UUID is generated.

but in the end i thought the clause (ending "readable") was easy enough to read
without the comma and florian;s text was maybe as simple as we can make
it. so i didn;t comment!

so i'd be ok with adding a comma after "readable" (but think we can skip
it) but think we need at least the comma after "new".

jmc

> > +.Pp
> >  A running
> >  .Nm
> >  can be controlled with the
> > @@ -70,6 +79,8 @@ Default
> >  configuration file.
> >  .It Pa /var/db/dhcp6leased/ Ns Aq Ar if
> >  Interface specific lease files.
> > +.It Pa /var/db/dhcp6leased/uuid
> > +DUID to identify this client.
> >  .El
> >  .Sh SEE ALSO
> >  .Xr dhcp6leased.conf 5 ,
> > 
>