Bug 273480

Summary: scandir.3: missing return type for scandirat, argument type and argument name must be enclosed in double quotations marks
Product: Documentation Reporter: Trond Endrestøl <Trond.Endrestol>
Component: Manual PagesAssignee: freebsd-bugs (Nobody) <bugs>
Status: Closed FIXED    
Severity: Affects Only Me CC: doc, freebsd, markj
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
Patch for lib/libc/gen/scandir.3
none
Patch for lib/libc/gen/scandir.3
none
Patch for lib/libc/gen/scandir.3
none
Patch for lib/libc/gen/scandir.3
none
Patch for lib/libc/gen/scandir.3
none
Patch for lib/libc/gen/scandir.3 none

Description Trond Endrestøl 2023-08-31 15:23:35 UTC
Missing return type for scandirat.
Argument type and argument name must be enclosed in double quotations marks.
Comment 1 Trond Endrestøl 2023-08-31 15:24:35 UTC
Created attachment 244526 [details]
Patch for lib/libc/gen/scandir.3
Comment 2 Trond Endrestøl 2023-08-31 15:29:15 UTC
Created attachment 244527 [details]
Patch for lib/libc/gen/scandir.3

Also corrects caret to asterisk for compar argument for scandir_b.
Comment 3 Trond Endrestøl 2023-08-31 15:32:33 UTC
Created attachment 244528 [details]
Patch for lib/libc/gen/scandir.3

Function names must be on the same line as the .Fn request.
Comment 4 Trond Endrestøl 2023-08-31 15:36:32 UTC
Created attachment 244529 [details]
Patch for lib/libc/gen/scandir.3

Fixed another caret.
Comment 5 Mina Galić freebsd_triage 2023-08-31 16:17:15 UTC
^Triage:reassigned to Docs / man pages
Comment 6 Trond Endrestøl 2023-08-31 16:18:24 UTC
Created attachment 244531 [details]
Patch for lib/libc/gen/scandir.3

The carets are Apple extensions, but they are not part the function pointers, only their signature. I could be wrong.
Comment 7 Trond Endrestøl 2023-08-31 16:27:23 UTC
Created attachment 244532 [details]
Patch for lib/libc/gen/scandir.3

At least the two function/block pointers are consistent. I'm sorry for all the noise.
Comment 8 commit-hook freebsd_committer freebsd_triage 2023-09-01 20:57:30 UTC
A commit in branch main references this bug:

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

commit b7000cadfbf312b6a8acff6b7a3bbbbe55509565
Author:     Trond Endrestøl <Trond.Endrestol@ximalas.info>
AuthorDate: 2023-09-01 20:48:16 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2023-09-01 20:57:03 +0000

    scandir.3: Fix several typos

    PR:             273480
    Reviewed by:    markj
    MFC after:      1 week

 lib/libc/gen/scandir.3 | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
Comment 9 commit-hook freebsd_committer freebsd_triage 2023-09-08 13:39:46 UTC
A commit in branch stable/13 references this bug:

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

commit 8ded9cd3d5540da9b88d052a857f7fa0c18855e2
Author:     Trond Endrestøl <Trond.Endrestol@ximalas.info>
AuthorDate: 2023-09-01 20:48:16 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2023-09-08 13:38:10 +0000

    scandir.3: Fix several typos

    PR:             273480
    Reviewed by:    markj
    MFC after:      1 week

    (cherry picked from commit b7000cadfbf312b6a8acff6b7a3bbbbe55509565)

 lib/libc/gen/scandir.3 | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
Comment 10 commit-hook freebsd_committer freebsd_triage 2023-09-09 15:49:00 UTC
A commit in branch stable/14 references this bug:

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

commit d0a5da5c1cf9c8d2c19b267e4db0fa2e28838f9d
Author:     Trond Endrestøl <Trond.Endrestol@ximalas.info>
AuthorDate: 2023-09-01 20:48:16 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2023-09-09 15:41:02 +0000

    scandir.3: Fix several typos

    PR:             273480
    Reviewed by:    markj
    MFC after:      1 week

    (cherry picked from commit b7000cadfbf312b6a8acff6b7a3bbbbe55509565)

 lib/libc/gen/scandir.3 | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
Comment 11 commit-hook freebsd_committer freebsd_triage 2023-09-09 17:22:19 UTC
A commit in branch releng/14.0 references this bug:

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

commit 425c8e509df1c83a11bf887d2c70ff164fc9ca0f
Author:     Trond Endrestøl <Trond.Endrestol@ximalas.info>
AuthorDate: 2023-09-01 20:48:16 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2023-09-09 17:21:37 +0000

    scandir.3: Fix several typos

    Approved by:    re (cperciva)
    PR:             273480
    Reviewed by:    markj
    MFC after:      1 week

    (cherry picked from commit b7000cadfbf312b6a8acff6b7a3bbbbe55509565)
    (cherry picked from commit d0a5da5c1cf9c8d2c19b267e4db0fa2e28838f9d)

 lib/libc/gen/scandir.3 | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)