Bug 256103 - DRIVER_MODULE.9 has incorrect SYNOPSIS for EARLY_DRIVER_MODULE()
Summary: DRIVER_MODULE.9 has incorrect SYNOPSIS for EARLY_DRIVER_MODULE()
Status: Closed FIXED
Alias: None
Product: Base System
Classification: Unclassified
Component: misc (show other bugs)
Version: CURRENT
Hardware: Any Any
: --- Affects Some People
Assignee: Gordon Bergling
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-05-23 15:13 UTC by J.R. Oldroyd
Modified: 2021-06-01 05:49 UTC (History)
1 user (show)

See Also:

Attachments
patch to remove incorrect argument in man page SYNOPSIS (915 bytes, patch)
2021-05-23 15:13 UTC, J.R. Oldroyd 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description J.R. Oldroyd 2021-05-23 15:13:45 UTC 
Created attachment 225199 [details]
patch to remove incorrect argument in man page SYNOPSIS

The man page SYNOPSIS for EARLY_DRIVER_MODULE() shows that it has an "enum sysinit_elem_order order" argument.

The actual macro in sys/bus.h does not have an order argument.

Can be MFC'd to 13 and 12.
Comment 1 Gordon Bergling freebsd_committer freebsd_triage 2021-05-24 12:21:36 UTC 
I created a differential based on your patch.
Comment 2 commit-hook freebsd_committer freebsd_triage 2021-05-24 14:57:41 UTC 
A commit in branch main references this bug:

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

commit 3fdd5c1e49cbc0a77935eb34e3561c6021b93650
Author:     J.R. Oldroyd <fbsd@opal.com>
AuthorDate: 2021-05-24 14:54:45 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2021-05-24 14:54:45 +0000

    DRIVER_MODULE(9): Correct the SYNOPSIS of EARLY_DRIVER_MODULE()

    The man page SYNOPSIS for EARLY_DRIVER_MODULE() shows that it has
    an "enum sysinit_elem_order order" argument.

    The actual macro in sys/bus.h does not have an order argument.

    PR:     256103
    Reported by:    J.R. Oldroyd <fbsd at opal dot com>
    Reviewed by:    markj
    MFC after:      1 week
    Differential Revision:  https://reviews.freebsd.org/D30411

 share/man/man9/DRIVER_MODULE.9 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 3 commit-hook freebsd_committer freebsd_triage 2021-06-01 05:33:45 UTC 
A commit in branch stable/13 references this bug:

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

commit fe0ff38bf1570936a7155d6dbae97aaaba3b667f
Author:     J.R. Oldroyd <fbsd@opal.com>
AuthorDate: 2021-05-24 14:54:45 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2021-06-01 05:32:48 +0000

    DRIVER_MODULE(9): Correct the SYNOPSIS of EARLY_DRIVER_MODULE()

    The man page SYNOPSIS for EARLY_DRIVER_MODULE() shows that it has
    an "enum sysinit_elem_order order" argument.

    The actual macro in sys/bus.h does not have an order argument.

    PR:     256103
    Reported by:    J.R. Oldroyd <fbsd at opal dot com>
    Reviewed by:    markj
    Differential Revision:  https://reviews.freebsd.org/D30411

    (cherry picked from commit 3fdd5c1e49cbc0a77935eb34e3561c6021b93650)

 share/man/man9/DRIVER_MODULE.9 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 4 commit-hook freebsd_committer freebsd_triage 2021-06-01 05:34:45 UTC 
A commit in branch stable/12 references this bug:

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

commit e303e19dfc0d2fd94301f213e8f7be1dcf597dc2
Author:     J.R. Oldroyd <fbsd@opal.com>
AuthorDate: 2021-05-24 14:54:45 +0000
Commit:     Gordon Bergling <gbe@FreeBSD.org>
CommitDate: 2021-06-01 05:34:07 +0000

    DRIVER_MODULE(9): Correct the SYNOPSIS of EARLY_DRIVER_MODULE()

    The man page SYNOPSIS for EARLY_DRIVER_MODULE() shows that it has
    an "enum sysinit_elem_order order" argument.

    The actual macro in sys/bus.h does not have an order argument.

    PR:     256103
    Reported by:    J.R. Oldroyd <fbsd at opal dot com>
    Reviewed by:    markj
    Differential Revision:  https://reviews.freebsd.org/D30411

    (cherry picked from commit 3fdd5c1e49cbc0a77935eb34e3561c6021b93650)

 share/man/man9/DRIVER_MODULE.9 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 5 Gordon Bergling freebsd_committer freebsd_triage 2021-06-01 05:49:02 UTC 
Corrected in main stable/13 and stable/12.

Thanks for spotting this.