Index | Thread | Search

From:
Jason McIntyre <jmc@kerhand.co.uk>
Subject:
Re: Diff: Minor Improvement to Sentence
To:
tech@openbsd.org
Date:
Thu, 8 Aug 2024 06:45:11 +0100

Download raw body.

Thread
  • Jason McIntyre:

    Diff: Minor Improvement to Sentence

  • On Thu, Aug 08, 2024 at 05:18:41AM +0000, Andrew Christopher Hawk wrote:
    > I was checking out dhcpleased(8)'s manual page, and a certain sentence
    > had me bugging out a bit, so I tried to fix up the sentence in
    > question.?? The diff follows my signature.
    > 
    > I *also* made some other changes, but GitHub seems to *really* hate the
    > idea of combining diffs, and this system is low on disk space, so using
    > my local Git installation for this purpose seems to be right out.?? In
    > the future, can I attach multiple commits in a single message, or should
    > I just aim to minimize the size of these messages?
    > 
    
    hi.
    
    i can;t answer your questions on github, but at least want to note that
    your diff is mangled.
    
    anyway, regarding the actual diff: i agree that sentence is a horror. i
    suggest we just simplify it to:
    
    	It requests IP configuration information from DHCP servers,
    	on interfaces with the AUTOCONF4 flag set.
    
    i don;t think we need to explicitly ref dhcpd(8) here.
    
    i also don;t think we need to change the structure of "on interfaces
    with the X flag set" to "and uses any such information to configure
    interfaces on which the X flag is set". that's just a lengthier text.
    
    hmm, now that i reread it perhaps there is value in saying that it is to
    configure these interfaces. i wonder if we have the whole thing the
    wrong way around. what about:
    
    	It configures interfaces with the AUTOCONF4 flag set by
    	requesting IP configuration information from DHCP servers.
    
    i guess what it does is more relevant that how it does it.
    
    jmc
    
    > Take care,
    > Andrew Christopher Hawk
    > "there's no second ive lived you can't call your own"
    > xmpp:ach@jabb3r.org
    > matrix:@ach:nitro.chat
    > mailto:andrew.hawk@blackburn.edu
    > mailto:andrewchawk@hotmail.com
    > 
    > diff --git a/sbin/dhcpleased/dhcpleased.8 b/sbin/dhcpleased/dhcpleased.8
    > index 4b42b5639e6..e185fbc04e7 100644
    > --- a/sbin/dhcpleased/dhcpleased.8
    > +++ b/sbin/dhcpleased/dhcpleased.8
    > @@ -28,11 +28,11 @@
    > ??.Sh DESCRIPTION
    > ??.Nm
    > ??is a dynamic host configuration protocol (DHCP) daemon for clients.
    > -It requests IP configuration information from for example those offered by
    > +It requests IP configuration information from DHCP servers, e.g.,
    > ??.Xr dhcpd 8 ,
    > -on interfaces with the
    > +and uses any such information to configure interfaces on which the
    > ??.Sy AUTOCONF4
    > -flag set.
    > +flag is set.
    > ??See
    > ??.Xr hostname.if 5
    > ??and
    > 
    
    
    
  • Jason McIntyre:

    Diff: Minor Improvement to Sentence