Skip to contentSkip to conversation

man3/creal.3, man3/cimag.3: Standardize style and history

PATCH New Simon Essien 1 participant 3 messages Jan 6 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/3 man3/creal.3, man3/cimag.3: Standardize style and history

Consolidated VERSIONS and HISTORY sections to match project standards. Moved GNU extension notes for __real__ and __imag__ to a clearer format within VERSIONS.

---
 man/man3/cimag.3 | 11 ++++-------
 man/man3/creal.3 | 11 ++++-------
 2 files changed, 8 insertions(+), 14 deletions(-)
man/man3/cimag.3 +4 -7
index 39eeb1007..946e095a8 100644
@@ -45,14 +45,11 @@ T{
 T}	Thread safety	MT-Safe
 .TE
 .SH VERSIONS
-GCC also supports __imag__.
-That is a GNU extension.
+Available since glibc 2.1.
+GCC also supports the
+.BR __real__
+keyword (a GNU extension).
 .SH STANDARDS
 C11, POSIX.1-2008.
 .SH HISTORY
-glibc 2.1.
 C99, POSIX.1-2001.
-.SH SEE ALSO
-.BR cabs (3),
-.BR creal (3),
-.BR complex (7)
man/man3/creal.3 +4 -7
index be07d8273..d05125274 100644
@@ -43,14 +43,11 @@ T{
 T}	Thread safety	MT-Safe
 .TE
 .SH VERSIONS
-GCC supports also __real__.
-That is a GNU extension.
+Available since glibc 2.1.
+GCC also supports the
+.BR __real__
+keyword (a GNU extension).
 .SH STANDARDS
 C11, POSIX.1-2008.
 .SH HISTORY
-glibc 2.1.
 C99, POSIX.1-2001.
-.SH SEE ALSO
-.BR cabs (3),
-.BR cimag (3),
-.BR complex (7)
Signature · 1 line
2.51.0
#1 lore raw

PATCH 2/3 man2: update glibc wrapper status and clean up FIXMEs

Update seccomp(2) to reflect that glibc 2.33 added a wrapper. Update sched_setattr(2) to remove obsolete FIXME markers, as the lack of a glibc wrapper is already correctly noted in the text.

---
 man/man2/sched_setattr.2 | 5 +----
 man/man2/seccomp.2       | 4 ++--
 2 files changed, 3 insertions(+), 6 deletions(-)
man/man2/sched_setattr.2 +1 -4
index 6d5718022..c8010b8fa 100644
@@ -460,7 +460,6 @@ does not include all CPUs in the system
 Linux.
 .SH HISTORY
 Linux 3.14.
-.\" FIXME . Add glibc version
 .SH NOTES
 glibc does not provide wrappers for these system calls;
 call them using
@@ -482,9 +481,7 @@ provides a superset of the functionality of
 and (partially)
 .BR getpriority (2).
 .SH BUGS
-In Linux versions up to
-.\" FIXME . patch sent to Peter Zijlstra
-3.15,
+In Linux versions up to 3.15,
 .BR sched_setattr ()
 failed with the error
 .B EFAULT
man/man2/seccomp.2 +2 -2
index 125794880..685ed4713 100644
@@ -25,7 +25,7 @@ Standard C library
 .fi
 .P
 .IR Note :
-glibc provides no wrapper for
+Before glibc 2.33, glibc provided no wrapper for
 .BR seccomp (),
 necessitating the use of
 .BR syscall (2).
@@ -863,7 +863,7 @@ be determined.
 Linux.
 .SH HISTORY
 Linux 3.17.
-.\" FIXME . Add glibc version
+Glibc 2.33.
 .SH NOTES
 Rather than hand-coding seccomp filters as shown in the example below,
 you may prefer to employ the
Signature · 1 line
2.51.0
#2 lore raw

PATCH 3/3 path_resolution.7: document read-only mounts, ACLs, and immutable files

In reply to Simon Essien

Address several FIXMEs by adding brief mentions of:
- EROFS errors on read-only filesystems.
- Access restrictions from filesystem ACLs.
- Access restrictions from immutable file attributes.

---
 man/man2/sched_setattr.2   |  7 -------
 man/man7/path_resolution.7 | 18 +++++++++++++++---
 2 files changed, 15 insertions(+), 10 deletions(-)
man/man2/sched_setattr.2 +0 -7
index c8010b8fa..ba6eb9196 100644
@@ -20,7 +20,6 @@ Standard C library
 .BI "int syscall(SYS_sched_getattr, pid_t " pid ", struct sched_attr *" attr ,
 .BI "            unsigned int " size ", unsigned int " flags );
 .fi
-.\" FIXME . Add feature test macro requirements
 .P
 .IR Note :
 glibc provides no wrappers for these system calls,
@@ -498,12 +497,6 @@ if the in-kernel
 structure was larger than the
 .I size
 passed by user space.
-.\" In Linux versions up to up 3.15,
-.\" FIXME . patch from Peter Zijlstra pending
-.\" .BR sched_setattr ()
-.\" allowed a negative
-.\" .I attr.sched_policy
-.\" value.
 .SH SEE ALSO
 .ad l
 .nh
man/man7/path_resolution.7 +15 -3
index cdf21e1f7..78573f3c2 100644
@@ -225,7 +225,12 @@ Similarly, Linux uses the fsgid ("filesystem group ID")
 instead of the effective group ID.
 See
 .BR setfsgid (2).
-.\" FIXME . say something about filesystem mounted read-only ?
+.P
+Even if a process has the necessary permissions to access or
+modify a file, an attempt to modify any part of the filesystem
+will fail with the error
+.B EROFS
+if the filesystem is currently mounted read-only.
 .SS Bypassing permission checks: superuser and capabilities
 On a traditional UNIX system, the superuser
 .RI ( root ,
@@ -256,8 +261,15 @@ The
 .B CAP_DAC_READ_SEARCH
 capability grants read and search permission
 on directories, and read permission on ordinary files.
-.\" FIXME . say something about immutable files
-.\" FIXME . say something about ACLs
+.P
+Beyond the standard permissions, access may also be restricted by
+filesystem-specific ACLs (Access Control Lists) or by
+immutable file attributes.
+See
+.BR acl (5)
+and
+.BR chattr (1)
+for more details.
 .SH SEE ALSO
 .BR readlink (2),
 .BR capabilities (7),
Signature · 1 line
2.51.0