From https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=215612
Remove obsolete notes about using read(2) and write(2) with shared memory objects.
Add note about the requirement of using ftruncate(2) before writing to a shared memory object.
Details
Details
- Reviewers
jilles rwatson - Group Reviewers
manpages - Commits
- rS312083: Update the shm_open.2 man page to reflect objective reality.
Throw myself on the mercy of reviewers.
Diff Detail
Diff Detail
- Lint
Lint Skipped - Unit
Tests Skipped
Event Timeline
| lib/libc/sys/shm_open.2 | ||
|---|---|---|
| 190 | From my POV, this is already documented there:
If ever retain this chunk, I'd rather move it into EXAMPLES or so. | |
| 217–218 | This is usually written in this form: The .Fn shm_open system call will fail if: | |
| lib/libc/sys/shm_open.2 | ||
|---|---|---|
| 190 | The point here is that a write(2) will not extend the object. That is only documented in the cited parts by omission, and I think that is insufficiently clear. | |
| lib/libc/sys/shm_open.2 | ||
|---|---|---|
| 174–175 | Nitpick: .Tn POSIX | |
| 192–194 | It may be clearer here to say something like Since writes do not extend a shared memory object, .Xr ftruncate 2 needs to be called before any data can be written. On another note, the usual spelling seems to be "shared memory object", not "shared-memory object" (ignoring usual spelling rules but looking at the existing documentation and the POSIX specification). | |
Comment Actions
Update for feedback and move examples section before errors section in an unsuccessful attempt to get mandoc to not complain about it. But it's closer than it was.