winsup/doc/posix.xml: add note for getrlimit, setrlimit, xrefs to notes

change notes to see "Implementation Notes" to xref to std-notes;
add xref to std-notes to getrlimit, setrlimit;
add note to document limitations of getrlimit, setrlimit resources support
This commit is contained in:
Brian Inglis 2021-02-15 15:35:39 -07:00 committed by Corinna Vinschen
parent ad28775055
commit 2caca30309
1 changed files with 57 additions and 44 deletions

View File

@ -64,7 +64,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
atoi atoi
atol atol
atoll atoll
basename (see chapter "Implementation Notes") basename (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
bind bind
bsearch bsearch
btowc btowc
@ -126,8 +126,8 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
clock_getcpuclockid clock_getcpuclockid
clock_getres clock_getres
clock_gettime clock_gettime
clock_nanosleep (see chapter "Implementation Notes") clock_nanosleep (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
clock_settime (see chapter "Implementation Notes") clock_settime (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
clog clog
clogf clogf
clogl clogl
@ -242,7 +242,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
fchown fchown
fchownat fchownat
fclose fclose
fcntl (see chapter "Implementation Notes") fcntl (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
fdatasync fdatasync
fdim fdim
fdimf fdimf
@ -292,7 +292,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
fopen fopen
fork fork
fpathconf fpathconf
fpclassify (see chapter "Implementation Notes") fpclassify (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
fprintf fprintf
fputc fputc
fputs fputs
@ -347,7 +347,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
getgroups getgroups
gethostid gethostid
gethostname gethostname
getitimer (see chapter "Implementation Notes") getitimer (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
getline getline
getlogin getlogin
getlogin_r getlogin_r
@ -367,7 +367,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
getpwnam_r getpwnam_r
getpwuid getpwuid
getpwuid_r getpwuid_r
getrlimit getrlimit (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
getrusage getrusage
gets gets
getservbyname getservbyname
@ -428,26 +428,26 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
iscntrl_l iscntrl_l
isdigit isdigit
isdigit_l isdigit_l
isfinite (see chapter "Implementation Notes") isfinite (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isgraph isgraph
isgraph_l isgraph_l
isgreater (see chapter "Implementation Notes") isgreater (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isgreaterequal (see chapter "Implementation Notes") isgreaterequal (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isinf (see chapter "Implementation Notes") isinf (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isless isless
islessequal (see chapter "Implementation Notes") islessequal (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
islessgreater (see chapter "Implementation Notes") islessgreater (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
islower islower
islower_l islower_l
isnan (see chapter "Implementation Notes") isnan (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isnormal (see chapter "Implementation Notes") isnormal (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isprint isprint
isprint_l isprint_l
ispunct ispunct
ispunct_l ispunct_l
isspace isspace
isspace_l isspace_l
isunordered (see chapter "Implementation Notes") isunordered (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
isupper isupper
isupper_l isupper_l
iswalnum iswalnum
@ -511,7 +511,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
localeconv localeconv
localtime localtime
localtime_r localtime_r
lockf (see chapter "Implementation Notes") lockf (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
log log
log10 log10
log10f log10f
@ -579,10 +579,10 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
mq_timedsend mq_timedsend
mq_unlink mq_unlink
mrand48 mrand48
msgctl (see chapter "Implementation Notes") msgctl (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
msgget (see chapter "Implementation Notes") msgget (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
msgrcv (see chapter "Implementation Notes") msgrcv (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
msgsnd (see chapter "Implementation Notes") msgsnd (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
msync msync
munlock munlock
munmap munmap
@ -834,9 +834,9 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
sem_trywait sem_trywait
sem_unlink sem_unlink
sem_wait sem_wait
semctl (see chapter "Implementation Notes") semctl (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
semget (see chapter "Implementation Notes") semget (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
semop (see chapter "Implementation Notes") semop (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
send send
sendmsg sendmsg
sendto sendto
@ -847,7 +847,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
setgid setgid
setgrent setgrent
sethostent sethostent
setitimer (see chapter "Implementation Notes") setitimer (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
setjmp setjmp
setkey (available in external "crypt" library) setkey (available in external "crypt" library)
setlocale setlocale
@ -859,7 +859,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
setpwent setpwent
setregid setregid
setreuid setreuid
setrlimit setrlimit (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
setservent setservent
setsid setsid
setsockopt setsockopt
@ -869,10 +869,10 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
setvbuf setvbuf
shm_open shm_open
shm_unlink shm_unlink
shmat (see chapter "Implementation Notes") shmat (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
shmctl (see chapter "Implementation Notes") shmctl (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
shmdt (see chapter "Implementation Notes") shmdt (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
shmget (see chapter "Implementation Notes") shmget (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
shutdown shutdown
sigaction sigaction
sigaddset sigaddset
@ -886,9 +886,9 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
sigismember sigismember
siglongjmp siglongjmp
signal signal
signbit (see chapter "Implementation Notes") signbit (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
signgam signgam
sigpause (see chapter "Implementation Notes") sigpause (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
sigpending sigpending
sigprocmask sigprocmask
sigqueue sigqueue
@ -937,7 +937,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
strdup strdup
strerror strerror
strerror_l strerror_l
strerror_r (see chapter "Implementation Notes") strerror_r (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
strfmon strfmon
strfmon_l strfmon_l
strftime strftime
@ -1001,7 +1001,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
tgammaf tgammaf
tgammal tgammal
time time
timer_create (see chapter "Implementation Notes") timer_create (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
timer_delete timer_delete
timer_getoverrun timer_getoverrun
timer_gettime timer_gettime
@ -1162,7 +1162,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
finitef finitef
finitel finitel
fiprintf fiprintf
flock (see chapter "Implementation Notes") flock (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
fls fls
flsl flsl
flsll flsll
@ -1212,7 +1212,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
madvise madvise
mkstemps mkstemps
openpty openpty
qsort_r (see chapter "Implementation Notes") qsort_r (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
rcmd rcmd
rcmd_af rcmd_af
reallocarray reallocarray
@ -1257,7 +1257,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
valloc valloc
verr verr
verrx verrx
vhangup (see chapter "Implementation Notes") vhangup (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
vsyslog vsyslog
vwarn vwarn
vwarnx vwarnx
@ -1291,14 +1291,14 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
asnprintf asnprintf
asprintf asprintf
asprintf_r asprintf_r
basename (see chapter "Implementation Notes") basename (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
canonicalize_file_name canonicalize_file_name
clearenv clearenv
clog10 clog10
clog10f clog10f
clog10l clog10l
crypt_r (available in external "crypt" library) crypt_r (available in external "crypt" library)
dladdr (see chapter "Implementation Notes") dladdr (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
dremf dremf
dup3 dup3
envz_add envz_add
@ -1370,8 +1370,8 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
ptsname_r ptsname_r
putwc_unlocked putwc_unlocked
putwchar_unlocked putwchar_unlocked
renameat2 (see chapter "Implementation Notes") renameat2 (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
qsort_r (see chapter "Implementation Notes") qsort_r (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
quotactl quotactl
rawmemchr rawmemchr
removexattr removexattr
@ -1545,8 +1545,8 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
bcmp (POSIX.1-2001, SUSv3) bcmp (POSIX.1-2001, SUSv3)
bcopy (SUSv3) bcopy (SUSv3)
bzero (SUSv3) bzero (SUSv3)
chroot (SUSv2) (see chapter "Implementation Notes") chroot (SUSv2) (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
clock_setres (QNX, VxWorks) (see chapter "Implementation Notes") clock_setres (QNX, VxWorks) (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
cuserid (POSIX.1-1988, SUSv2) cuserid (POSIX.1-1988, SUSv2)
ecvt (SUSv3) ecvt (SUSv3)
endutent (XPG2) endutent (XPG2)
@ -1592,7 +1592,7 @@ also IEEE Std 1003.1-2008 (POSIX.1-2008).</para>
ualarm (SUSv3) ualarm (SUSv3)
usleep (SUSv3) usleep (SUSv3)
utmpname (XPG2) utmpname (XPG2)
vfork (SUSv3) (see chapter "Implementation Notes") vfork (SUSv3) (see <xref linkend="std-notes">chapter "Implementation Notes"</xref>)
</screen> </screen>
</sect1> </sect1>
@ -1727,6 +1727,19 @@ flavors, depending on whether _GNU_SOURCE is defined when compiling.</para>
<para><function>dladdr</function> always sets the Dl_info members dli_sname and <para><function>dladdr</function> always sets the Dl_info members dli_sname and
dli_saddr to NULL, indicating no symbol matching addr could be found.</para> dli_saddr to NULL, indicating no symbol matching addr could be found.</para>
<para><function>getrlimit</function> resources RLIMIT_AS, RLIMIT_CPU,
RLIMIT_FSIZE, RLIMIT_DATA always return rlim_cur and rlim_max as RLIM_INFINITY,
so <function>setrlimit</function> returns -1 and sets EINVAL if they are
lowered, or returns 0 if unchanged.
<function>getrlimit</function> resource RLIMIT_NOFILE always returns rlim_cur
and rlim_max as OPEN_MAX; <function>setrlimit</function> returns 0 sets EINVAL
if rlim_cur > rlim_max, does not change the value if it is RLIM_INFINITY,
otherwise returns the result from <function>setdtablesize</function>.
<function>getrlimit</function>/<function>setrlimit</function> resources
RLIMIT_CORE and RLIMIT_STACK return the current values and set the requested
values.
All other resource arguments return -1 and set EINVAL.</para>
</sect1> </sect1>
</chapter> </chapter>