Document that `sendfile` will return an invalid value for `sbytes` if provided an invalid address
ClosedPublic
Actions

Authored by ngie on Jan 24 2019, 10:11 PM.

Details

Reviewers

emaste
glebius
jtl
markj
0mp

Group Reviewers

manpages

Commits

rS343444: Document that `sendfile` will return an invalid value for `sbytes` if provided…

Summary

This is meant to clarify the fact that the system call will not fail
with -1/EFAULT, as one might expect, when reading the sendfile(2)
manpage today.

While here, pet the mandoc linter, when dealing with the section that
describes valid values for flags.

PR: 232210

Test Plan

make -C lib/libc/ sendfile.2lint

igor lib/libc/sendfile.2

(this fails citing a bogus issue with the AUTHORS section.

Diff Detail

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 22133
Build 21354: arc lint + arc unit

Event Timeline

ngie created this revision.Jan 24 2019, 10:11 PM

Harbormaster completed remote builds in B22131: Diff 53175.Jan 24 2019, 10:11 PM

ngie added a reviewer: manpages.Jan 24 2019, 10:14 PM

glebius added inline comments.Jan 24 2019, 10:33 PM

lib/libc/sys/sendfile.2
107	Why this change?
418	I'm not native speaker, but my reading of this phrase is ambigous: sendfile will not return -1 and fail with EFAULT in that case May be wording like this would be more clear: sendfile will not return -1 and will not set errno to EFAULT in that case ?

ngie marked an inline comment as done.Jan 24 2019, 10:41 PM

ngie added inline comments.

lib/libc/sys/sendfile.2

107

I will commit this change separately. Basically, I was fixing a linter issue:

$ make -C ~/nfs/svn/freebsd/base/head/lib/libc sendfile.2lint
[Creating objdir /usr/obj/usr/home/ngie/nfs/svn/freebsd/base/head/amd64.amd64/lib/msun...]
mandoc -Tascii -Tlint /usr/home/ngie/nfs/svn/freebsd/base/head/lib/libc/sys/sendfile.2
mandoc: /usr/home/ngie/nfs/svn/freebsd/base/head/lib/libc/sys/sendfile.2:107:2: WARNING: missing -width in -tag list, using 6n: Bl -tag
*** Error code 2

Stop.
make: stopped in /home/ngie/nfs/svn/freebsd/base/head/lib/libc

418

You're right -- it was poorly worded. Let me reword it.