Bug 285614 - man dhclient.conf contains an error in script description
Summary: man dhclient.conf contains an error in script description
Status: In Progress
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Mark Johnston
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2025-03-23 20:31 UTC by ev
Modified: 2026-06-22 13:27 UTC (History)
4 users (show)

See Also:


Attachments
Patch incorporating both concerns (704 bytes, patch)
2025-03-24 17:50 UTC, Jim B.
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description ev 2025-03-23 20:31:57 UTC
man dhclient.conf contains an error in script description

>        script "script-name";
>	       The  script  statement  is  used	to specify the pathname	of the
>	       DHCP client configuration script.  This script is used  by  the
>	       DHCP client to set each interface's initial configuration prior
>	       to  requesting an address, to test the address once it has been
>	       offered,	and to set the interface's final configuration once  a
>	       lease  has  been	acquired.  If no lease is acquired, the	script
>	       is used to test predefined leases, if any, and also called once
>	       if no valid lease can be	identified.  For more information, see
>	       dhclient.leases(5).

last sentence should be

> For more information, see dhclient-script(8).
Comment 1 Ed Maste freebsd_committer freebsd_triage 2025-03-24 13:47:34 UTC
I think the intent is "For more information [on predefined leases], see..." and is appropriate in that context.

I agree there should be a reference to dhclient-script(8) as well, though.
Comment 2 Jim B. 2025-03-24 17:50:03 UTC
Created attachment 258980 [details]
Patch incorporating both concerns

A patch incorporating both concerns is attached.  The rendered section reads:

...
             used to test predefined leases, if any, and also called once if
             no valid lease can be identified.  For more information on
             predefined leases, see dhclient.leases(5).  Additional
             information on using DHCP client configuration scripts is found
             in dhclient.script(8).
...
Comment 3 Jim B. 2025-03-24 17:56:40 UTC
(In reply to Jim B. from comment #2)

Entered in phabricator as https://reviews.freebsd.org/D49489
Comment 4 commit-hook freebsd_committer freebsd_triage 2026-06-05 15:14:13 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=f4424a2733867ec5f12ecd196011ce8df096f522

commit f4424a2733867ec5f12ecd196011ce8df096f522
Author:     Jim Brown <jpb@jimby.name>
AuthorDate: 2026-06-05 14:59:32 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2026-06-05 15:13:32 +0000

    dhclient.conf.5: Correct crossreference

    PR:             285614
    Reviewed by:    ziaee, michaelo, jrm
    MFC after:      2 weeks
    Differential Revision:  https://reviews.freebsd.org/D49489

 sbin/dhclient/dhclient.conf.5 | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2026-06-22 13:27:17 UTC
A commit in branch stable/15 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=37517d6d91668611f15b95ba300d4934555cad44

commit 37517d6d91668611f15b95ba300d4934555cad44
Author:     Jim Brown <jpb@jimby.name>
AuthorDate: 2026-06-05 14:59:32 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2026-06-22 13:26:09 +0000

    dhclient.conf.5: Correct crossreference

    PR:             285614
    Reviewed by:    ziaee, michaelo, jrm
    MFC after:      2 weeks
    Differential Revision:  https://reviews.freebsd.org/D49489

    (cherry picked from commit f4424a2733867ec5f12ecd196011ce8df096f522)

 sbin/dhclient/dhclient.conf.5 | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)