dhclient.conf.5: Correct crossreference

[jpb_jimby.name]

Summary

PR: 285614

[ziaee]

Hey Jim, thanks for the patch! Adding manpages and some recent committers to dhclient for review.

sbin/dhclient/dhclient.conf.5

357–358

I'm not a SME, but I want to keep things as terse as possible in this style of document. Does it make sense to do this instead, and remove 360,361?

548

[michaelo]

sbin/dhclient/dhclient.conf.5

357–358

Am I blind or do I see only

DHCLIENT.LEASES(5)        FreeBSD File Formats Manual       DHCLIENT.LEASES(5)

[ziaee]

sbin/dhclient/dhclient.conf.5

357–358

Ah, you're correct. Leases is the . separated and script is the - separated.

[jpb_jimby.name]

Update dhclient.conf section on script statement.

[michaelo]

sbin/dhclient/dhclient.conf.5

358–363

Above "this" is used, here "the". It should be consistent.

[jpb_jimby.name]

Update dhclient.conf section on script statement.
Fix progression of reference on "script" option.

[jpb_jimby.name]

sbin/dhclient/dhclient.conf.5

358–363

I think the better fix here is to set up a progression of reference:

"The script statement is used to specify the pathname of a DHCP client configuration script."

where the indefinite article 'a' acts as a non-specific reference to a script supplied by the user of the command. Once the script is supplied (that is, identified by the option) it grammatically becomes a specific script.

In the next sentence:

"This script is used by the DHCP client to set each interface's initial configuration...",

the word 'this' functions as a demonstrative determiner that identifies the specific instance of a script - the one on the command option.

And in the next sentence,

"If no lease is acquired, the script is used to test predefined dhclient.leases(5), if any, ...",

the definite article 'the' is used to refer to the already known script.

This progression of "a -> this -> the" is a natural progression in the English language to manage information reference; introducing something new, specifying it, and then referring to it later in discourse.

Here is a reduction with the dependent, coordinate clauses removed:

"The script statement is used to specify the pathname of a DHCP
client configuration script. This script is used by the DHCP
client to set each interface's initial configuration. If no
lease is acquired, the script is used to test predefined
dhclient.leases(5)."

The actual patch will have all clauses included, of course.

[ziaee]

Is this patch related to a bug in the bug tracker?

[jpb_jimby.name]

In D49489#1128968, @ziaee wrote:

Is this patch related to a bug in the bug tracker?

Yes. Sorry, I forgot to add it. https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=285614

Jim B.

[michaelo]

I am fine with that.

[ziaee]

sbin/dhclient/dhclient.conf.5

549

By linting this page with mandoc -Tlint src/sbin/dhclient/dhclient.conf.5, I was reminded that FreeBSD doesn't have dhcpcd.8 or dhcpcd.conf.5 from OpenBSD, so those should also be removed.

[ziaee]

Following our discussion today about patch movement, @michaelo could commit this or I'd need @carlavilla or @mhorne to approve it. For me to do it, I need a better commit message. Unfortunately afaik you need to use the webapp to do this.

[michaelo]

In D49489#1135464, @ziaee wrote:

Following our discussion today about patch movement, @michaelo could commit this or I'd need @carlavilla or @mhorne to approve it. For me to do it, I need a better commit message. Unfortunately afaik you need to use the webapp to do this.

To commit that I need a Git-formatted patch.

[ziaee]

@jimb, check out how I edited the commit message title. The link I provided earlier explains the finer points of how to write this line, but basically, what is changing needs to come first, and notice the difference between dhclient.conf and dhclient.conf.5. The former could be assumed to be the default configuration itself, the second is the manual. Then comes a colon, then a space and then the explanation of what is being changed about it (capitalize the beginning).

@michaelo, src/tools/tools/git/git-arc.sh will do this for you. Use git arc patch -c D49489. But first, Jim is a recurring contributor, let me work with him on commit messages.

[jpb_jimby.name]

Fixed patch.

[michaelo]

In D49489#1135667, @ziaee wrote:

@michaelo, src/tools/tools/git/git-arc.sh will do this for you. Use git arc patch -c D49489. But first, Jim is a recurring contributor, let me work with him on commit messages.

Just tried, works like a charm, but I need approval from my mentors first: @jrm, @otis

[jrm]

In D49489#1135680, @michaelo wrote:

In D49489#1135667, @ziaee wrote:

@michaelo, src/tools/tools/git/git-arc.sh will do this for you. Use git arc patch -c D49489. But first, Jim is a recurring contributor, let me work with him on commit messages.

Just tried, works like a charm, but I need approval from my mentors first: @jrm, @otis

git-arc is also available as part of the freebsd-git-devtools package (devel/freebsd-git-devtools).