Commit graph

9 commits

Author SHA1 Message Date
artembunichev
8cebb06300 open.2: add separate paragraph for O_CREAT
PR:	284353
MFC after:	1 week
2025-02-28 12:29:12 +02:00
CismonX
c814172896 open.2: update description for O_PATH
- Add fstatfs(), fchdir(), fchroot(), extattr_*_fd(), cap_*_get(),
  cap_*_limit() to the list of syscalls that can take an O_PATH fd.
- Remove readlinkat() from the list, since it is already discussed
  in the first few lines of the paragraph.  It was originally added
  to the list when readlinkat() adds support for non-dir fd with
  an empty relative path (as if with AT_EMPTY_PATH), however,
  such use case is also discussed in the next paragraph.
- Add funlinkat() to the list, since it accepts an extra fd
  (of the file to be unlinked), which is worth extra mentioning.
- Fix a syntax issue which causes a bogus space to be rendered
  before a closing parentheses.

Signed-off-by: CismonX <admin@cismon.net>

Reviewed by:	markj, jhb
MFC after:	2 weeks
Pull Request:	https://github.com/freebsd/freebsd-src/pull/1564
2025-01-24 20:15:09 +00:00
John Baldwin
826509a3c3 open.2: Editorial pass
- Use a typical tagged list for the open flags instead of a literal
  block.  This permits using markup in the flag descriptions.  Also,
  drop the offset to avoid indenting the entire list.

- Note that O_RESOLVE_BENEATH only applies to openat(2)

- Use a clearer description of O_CLOEXEC (what it means, not the
  internal flag it sets)

- Note that exactly one permission flag is required.

- Split up a paragraph on various flags so that each flag gets its own
  paragraph.  Some flags already had their own paragraph, so this is
  more consistent.  It also makes it clearer which flag a sentence is
  talking about when a flag has more than one sentence.

- Appease some errors from igor and man2ps

- In the discussion about a returned directory descriptor opened with
  O_SEARCH, avoid the use of Fa fd since the descriptor in question is
  a return value and not an argument to open or openat.

- Various and sundry markup and language tweaks

Reviewed by:	kib, emaste
Differential Revision:	https://reviews.freebsd.org/D48253
2025-01-03 10:48:24 -05:00
Konstantin Belousov
37bb988410 open(2): devfs is in section 4 on HEAD
Noted by:	yuripv
Fixes:	f5a37f8dd3
2024-08-28 01:23:20 +03:00
Jose Luis Duran
02c23c3b5a open(2): Extend EINVAL's description
If O_CREAT is specified, the last component of the path argument can
contain invalid characters, and return EINVAL on some file systems.

PR:	281033
Differential revision:	https://reviews.freebsd.org/D46450
MFC after:   1 week
2024-08-28 01:09:33 +03:00
Jose Luis Duran
f5a37f8dd3 open(2): mandoc -T lint
Lint the manual, addressing almost all requests.

Differential revision:	https://reviews.freebsd.org/D46450
MFC after:   1 week
2024-08-28 01:09:33 +03:00
Alexander Ziaee
1a720cbec5 man filesystems: fix xrefs after move to section 4
Reviewed by: des, imp
Pull Request: https://github.com/freebsd/freebsd-src/pull/1077
2024-05-16 10:25:29 -06:00
Christopher Davidson
d3de1bd429 open.2: remove self-reference
Change .Xr reference to .Fn, which quiets a mandoc warning.

Reviewed by:	mhorne
MFC after:	3 days
Pull Request:	https://github.com/freebsd/freebsd-src/pull/1135
2024-04-03 13:55:24 -03:00
Brooks Davis
8269e7673c libsys: relocate implementations and manpages
Remove core system call implementations and documentation to lib/libsys
and lib/libsys/<arch> from lib/libc/sys and lib/libc/<arch>/<sys>.
Update paths to allow libc to find them in their new home.

Reviewed by:	kib, emaste, imp
Pull Request:	https://github.com/freebsd/freebsd-src/pull/908
2024-02-05 20:34:55 +00:00
Renamed from lib/libc/sys/open.2 (Browse further)