Bug 273561 - The jail.conf(5) man page paragraph on includes doesn't render correctly.
Summary: The jail.conf(5) man page paragraph on includes doesn't render correctly.
Status: Closed FIXED
Alias: None
Product: Base System
Classification: Unclassified
Component: misc (show other bugs)
Version: 14.0-STABLE
Hardware: Any Any
: --- Affects Many People
Assignee: Jamie Gritton
URL:
Keywords: easy
Depends on:
Blocks:
 
Reported: 2023-09-04 14:11 UTC by crest
Modified: 2023-09-14 17:17 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description crest 2023-09-04 14:11:17 UTC
The man page source:

.Ss Includes
A line of the form
.Bd -literal -offset ident
.include "filename";
.Ed
.Pp

does not render the `.include "filename";` line. The dot as first character on a line has to be quoted.
Comment 1 crest 2023-09-04 14:14:38 UTC
The .include has to be quoted as \&.include.
Comment 2 crest 2023-09-04 14:19:38 UTC
The man page also doesn't document the glob(3) expansion performed on the file name even though the examples contain glob patterns triggering the expansion. It would also be useful to document that "foo[.]conf" can be used as try include matching either "foo.conf" or nothing.
Comment 3 Jamie Gritton freebsd_committer freebsd_triage 2023-09-04 22:31:07 UTC
Take a look at https://reviews.freebsd.org/D41723

That covers the fix, and also adds a bit about filename globbing (and about relative pathnames).
Comment 4 commit-hook freebsd_committer freebsd_triage 2023-09-05 20:37:44 UTC
A commit in branch main references this bug:

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

commit 165234d5527440b7755b01554ff7633e33c0d285
Author:     Jamie Gritton <jamie@FreeBSD.org>
AuthorDate: 2023-09-05 20:35:54 +0000
Commit:     Jamie Gritton <jamie@FreeBSD.org>
CommitDate: 2023-09-05 20:35:54 +0000

    jail.conf(5): Fix and expand description of ".include".

    Escape a period that caused a line not to be includesd.  Also mention
    that glob(3) patterns may be included, and a consequence of that.

    PR:             273561
    Reported by:    crest@rlwinm.de
    Reviewed by:    emaste
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D41723

 usr.sbin/jail/jail.conf.5 | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2023-09-09 16:59:15 UTC
A commit in branch stable/14 references this bug:

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

commit 402d5960cb82eaccc33177aac821dbad1b42db1c
Author:     Jamie Gritton <jamie@FreeBSD.org>
AuthorDate: 2023-09-05 20:35:54 +0000
Commit:     Jamie Gritton <jamie@FreeBSD.org>
CommitDate: 2023-09-09 16:57:33 +0000

    MFC jail.conf(5): Fix and expand description of ".include".

    Escape a period that caused a line not to be includesd.  Also mention
    that glob(3) patterns may be included, and a consequence of that.

    PR:             273561
    Reported by:    crest@rlwinm.de
    Reviewed by:    emaste
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D41723

    (cherry picked from commit 165234d5527440b7755b01554ff7633e33c0d285)

 usr.sbin/jail/jail.conf.5 | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)
Comment 6 commit-hook freebsd_committer freebsd_triage 2023-09-14 17:16:34 UTC
A commit in branch releng/14.0 references this bug:

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

commit d737efcc1c2582c793be202ed337de2589ff5301
Author:     Jamie Gritton <jamie@FreeBSD.org>
AuthorDate: 2023-09-05 20:35:54 +0000
Commit:     Jamie Gritton <jamie@FreeBSD.org>
CommitDate: 2023-09-14 17:15:44 +0000

    MFS jail.conf(5): Fix and expand description of ".include".

    Escape a period that caused a line not to be includesd.  Also mention
    that glob(3) patterns may be included, and a consequence of that.

    Approved by:    re (gjb)
    PR:             273561
    Reported by:    crest@rlwinm.de
    Reviewed by:    emaste
    MFC after:      3 days
    Differential Revision:  https://reviews.freebsd.org/D41723

    (cherry picked from commit 165234d5527440b7755b01554ff7633e33c0d285)
    (cherry picked from commit 402d5960cb82eaccc33177aac821dbad1b42db1c)

 usr.sbin/jail/jail.conf.5 | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)