]> Savannah Git Hosting - gnulib.git/commitdiff
Document migration path for obsolescent functions.
authorBruno Haible <bruno@clisp.org>
Wed, 19 Jul 2023 23:35:10 +0000 (01:35 +0200)
committerBruno Haible <bruno@clisp.org>
Wed, 19 Jul 2023 23:35:10 +0000 (01:35 +0200)
* doc/glibc-functions/timespec_get.texi: Add reference to ISO C.
* doc/posix-functions/_tolower.texi: Recommend use of tolower.
* doc/posix-functions/_toupper.texi: Recommend use of toupper.
* doc/posix-functions/asctime.texi: Recommend use of strftime.
* doc/posix-functions/asctime_r.texi: Likewise.
* doc/posix-functions/ctime.texi: Recommend use of localtime_r and
strftime.
* doc/posix-functions/ctime_r.texi: Likewise.
* doc/posix-functions/ftw.texi: Recommend use of fts.
* doc/posix-functions/getitimer.texi: Recommend use of timer_gettime.
* doc/posix-functions/gets.texi: Recommend use of fgets.
* doc/posix-functions/gettimeofday.texi: Recommend use of gettime or
timespec_get.
* doc/posix-functions/inet_addr.texi: Recommend use of inet_pton.
* doc/posix-functions/inet_ntoa.texi: Recommend use of inet_ntop.
* doc/posix-functions/pthread_getconcurrency.texi: Recommend no-op.
* doc/posix-functions/pthread_setconcurrency.texi: Recommend no-op.
* doc/posix-functions/rand_r.texi: Recommend use of random_r.
* doc/posix-functions/setitimer.texi: Recommend use of timer_create and
timer_settime.
* doc/posix-functions/setpgrp.texi: Recommend use of setpgid or setsid.
* doc/posix-functions/sighold.texi: Recommend use of sigprocmask.
* doc/posix-functions/sigignore.texi: Recommend use of sigaction.
* doc/posix-functions/siginterrupt.texi: Recommend use of sigaction.
* doc/posix-functions/sigpause.texi: Recommend use of sigsuspend.
* doc/posix-functions/sigrelse.texi: Recommend use of sigprocmask.
* doc/posix-functions/sigset.texi: Recommend use of sigaction.
* doc/posix-functions/tempnam.texi: Recommend use of mkstemp.
* doc/posix-functions/ulimit.texi: Recommend use of getrlimit and
setrlimit.
* doc/posix-functions/utime.texi: Recommend use of utimens.

28 files changed:
ChangeLog
doc/glibc-functions/timespec_get.texi
doc/posix-functions/_tolower.texi
doc/posix-functions/_toupper.texi
doc/posix-functions/asctime.texi
doc/posix-functions/asctime_r.texi
doc/posix-functions/ctime.texi
doc/posix-functions/ctime_r.texi
doc/posix-functions/ftw.texi
doc/posix-functions/getitimer.texi
doc/posix-functions/gets.texi
doc/posix-functions/gettimeofday.texi
doc/posix-functions/inet_addr.texi
doc/posix-functions/inet_ntoa.texi
doc/posix-functions/pthread_getconcurrency.texi
doc/posix-functions/pthread_setconcurrency.texi
doc/posix-functions/rand_r.texi
doc/posix-functions/setitimer.texi
doc/posix-functions/setpgrp.texi
doc/posix-functions/sighold.texi
doc/posix-functions/sigignore.texi
doc/posix-functions/siginterrupt.texi
doc/posix-functions/sigpause.texi
doc/posix-functions/sigrelse.texi
doc/posix-functions/sigset.texi
doc/posix-functions/tempnam.texi
doc/posix-functions/ulimit.texi
doc/posix-functions/utime.texi

index ec8cd5261dee3d72ded1b7dc97c97debd5e8fbbc..8d6e3aab2e24e1e94028ba9f5bfbd5eb71c7e09a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,38 @@
+2023-07-19  Bruno Haible  <bruno@clisp.org>
+
+       Document migration path for obsolescent functions.
+       * doc/glibc-functions/timespec_get.texi: Add reference to ISO C.
+       * doc/posix-functions/_tolower.texi: Recommend use of tolower.
+       * doc/posix-functions/_toupper.texi: Recommend use of toupper.
+       * doc/posix-functions/asctime.texi: Recommend use of strftime.
+       * doc/posix-functions/asctime_r.texi: Likewise.
+       * doc/posix-functions/ctime.texi: Recommend use of localtime_r and
+       strftime.
+       * doc/posix-functions/ctime_r.texi: Likewise.
+       * doc/posix-functions/ftw.texi: Recommend use of fts.
+       * doc/posix-functions/getitimer.texi: Recommend use of timer_gettime.
+       * doc/posix-functions/gets.texi: Recommend use of fgets.
+       * doc/posix-functions/gettimeofday.texi: Recommend use of gettime or
+       timespec_get.
+       * doc/posix-functions/inet_addr.texi: Recommend use of inet_pton.
+       * doc/posix-functions/inet_ntoa.texi: Recommend use of inet_ntop.
+       * doc/posix-functions/pthread_getconcurrency.texi: Recommend no-op.
+       * doc/posix-functions/pthread_setconcurrency.texi: Recommend no-op.
+       * doc/posix-functions/rand_r.texi: Recommend use of random_r.
+       * doc/posix-functions/setitimer.texi: Recommend use of timer_create and
+       timer_settime.
+       * doc/posix-functions/setpgrp.texi: Recommend use of setpgid or setsid.
+       * doc/posix-functions/sighold.texi: Recommend use of sigprocmask.
+       * doc/posix-functions/sigignore.texi: Recommend use of sigaction.
+       * doc/posix-functions/siginterrupt.texi: Recommend use of sigaction.
+       * doc/posix-functions/sigpause.texi: Recommend use of sigsuspend.
+       * doc/posix-functions/sigrelse.texi: Recommend use of sigprocmask.
+       * doc/posix-functions/sigset.texi: Recommend use of sigaction.
+       * doc/posix-functions/tempnam.texi: Recommend use of mkstemp.
+       * doc/posix-functions/ulimit.texi: Recommend use of getrlimit and
+       setrlimit.
+       * doc/posix-functions/utime.texi: Recommend use of utimens.
+
 2023-07-19  Paul Eggert  <eggert@cs.ucla.edu>
 
        Document POSIX obsolescence
index 6f5b368d72919bc3d7105e4d3eac11040df18f88..195351c39228c7de8d1de5c216de87e103efdd1b 100644 (file)
@@ -2,6 +2,8 @@
 @subsection @code{timespec_get}
 @findex timespec_get
 
+ISO C23 specification:@* @url{http://www.open-std.org/jtc1/sc22/wg14/www/docs/n3047.pdf} section 7.29.2.6
+
 Gnulib module: timespec_get
 
 Portability problems fixed by Gnulib:
index 8446eac3d6e2c54c780e373f213e5e61685c7cba..381bc035e82dcb8298d422ad46adf107a703c4fd 100644 (file)
@@ -18,4 +18,5 @@ macOS 11.1, Minix 3.1.8, Android 4.4.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{tolower} instead.
 @end itemize
index 8bcf922a022a22c10d2955985477b0c4d8bc98f7..1196e297929f22ae624b4f2ffb7385aae2b418d7 100644 (file)
@@ -18,4 +18,5 @@ macOS 11.1, Minix 3.1.8, Android 4.4.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{toupper} instead.
 @end itemize
index d1a959d5c13eb03d3fbae1cbb2c531d9ba6e4206..c212a761182891b5203a60c2fd88c721919c472e 100644 (file)
@@ -14,10 +14,9 @@ Portability problems not fixed by Gnulib:
 @itemize
 @item
 This function is deprecated in C23.
-Portable applications can use @code{strftime} (or even @code{sprintf}) instead.
-@item
-POSIX says this function is obsolescent and it is planned to be
+Likewise, POSIX says this function is obsolescent and it is planned to be
 removed in a future version.
+Portable applications can use @code{strftime} (or even @code{sprintf}) instead.
 @item
 This function may overflow its internal buffer if an invalid year is passed.
 @end itemize
index df1b6c9264772180bdf16c44dfcf1b56e72d7a0f..3b19860363fc7a8f0271d7e1d01c6a0399fed3be 100644 (file)
@@ -23,6 +23,7 @@ mingw, MSVC 14.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in a future version.
+Use the function @code{strftime} (or even @code{sprintf}) instead.
 @item
 This function may put more than 26 bytes into the argument buffer if an
 invalid year is passed.
index 3e8bfcb7033c2629eb8ef1d3822581bc766ed55f..bab929c08c7b8abda0b5a4ccaaafcc41001e6d61 100644 (file)
@@ -17,12 +17,11 @@ Portability problems not fixed by Gnulib:
 @itemize
 @item
 This function is deprecated in C23.
+Likewise, POSIX says this function is obsolescent and it is planned to be
+removed in a future version.
 Portable applications can use @code{localtime_r} and @code{strftime}
 (or even @code{sprintf}) instead.
 @item
-POSIX says this function is obsolescent and it is planned to be
-removed in a future version.
-@item
 This function may overflow its internal buffer if an invalid year is passed.
 @item
 The @code{ctime} function need not be reentrant, and consequently is
index b9ecc6177ad574b9a1b26e0f0d7ea4e8f52f6983..8b5dd136cc481acdbc3150bb38aca65bbdfa1305 100644 (file)
@@ -23,6 +23,8 @@ mingw, MSVC 14.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in a future version.
+Use the functions @code{localtime_r} and @code{strftime}
+(or even @code{sprintf}) instead.
 @item
 This function may put more than 26 bytes into the argument buffer if an
 invalid year is passed.
index b6e8581b4c0214ba24b4bb0f52c319b3e7ac712a..5b61927775025eed82015142bc7957b8858dae5e 100644 (file)
@@ -21,4 +21,5 @@ FreeBSD 5.2.1, NetBSD 3.0, Minix 3.1.8, mingw, MSVC 14, Android 4.1.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the Gnulib module @code{fts} instead.
 @end itemize
index 1484366ed3d33c558be2d3c324927d49ffcd2839..64ce009f3e655a8d268baf7c50dad4aba08a13f3 100644 (file)
@@ -18,4 +18,5 @@ mingw, MSVC 14.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{timer_gettime} instead.
 @end itemize
index bb8c90777254bae333ccff7445579d407435505b..ecef336dcda5fc1b18725eb330f0cdc45d8fdc55 100644 (file)
@@ -20,6 +20,7 @@ OpenBSD 6.7, Solaris 11.4.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{fgets} instead.
 @item
 When reading from a non-blocking pipe whose buffer is empty, this function
 fails with @code{errno} being set to @code{EINVAL} instead of @code{EAGAIN} on
index 5a262685bc67fb663d761a090e43476f3b215a65..1cbe0ce8478219cae1f3850f70cb4c9d7ecf3592 100644 (file)
@@ -36,4 +36,7 @@ is not @code{NULL}.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the Gnulib module @code{gettime} or @code{timespec_get} instead.
+(POSIX recommends to use the function @code{clock_gettime}, but there is
+no corresponding Gnulib module for it yet.)
 @end itemize
index cfe9f9b254da3b8d8dd4023316beb10c02e3c361..04c620994cdae472b2737ad93257b5d6748c3d74 100644 (file)
@@ -18,6 +18,7 @@ mingw, MSVC 14.
 @item
 POSIX 202x says this function is obsolescent and it is planned to be
 removed in a future version.
+Use the function @code{inet_pton} instead.
 @item
 On some old platforms, this function returns a @samp{struct in_addr} rather
 than a scalar type such as @samp{unsigned int} or @samp{unsigned long}.
index afe029ec28bf9a686ed931c06ef926a93610942c..c181ea91fa9d98ccd11a94f70b971ec02a7d6252 100644 (file)
@@ -18,6 +18,7 @@ mingw, MSVC 14.
 @item
 POSIX 202x says this function is obsolescent and it is planned to be
 removed in a future version.
+Use the function @code{inet_ntop} instead.
 @item
 The @code{inet_ntoa} function need not be reentrant, and consequently
 is not required to be thread safe.  Implementations of
index 74210f552ec60b9fdaa391f985952c036b3ea5a1..31ba40700aff72520fc4101a7119919cf7f4fbc3 100644 (file)
@@ -18,4 +18,5 @@ NetBSD 9.0, Minix 3.1.8, mingw, MSVC 14, Android 9.0.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+You can remove calls to this function.
 @end itemize
index e1205ff394686b323d4526e6652e398b2a4c3bbb..6d3433aa41323add5d38c8b4dd38d836552d6994 100644 (file)
@@ -18,4 +18,5 @@ NetBSD 9.0, Minix 3.1.8, mingw, MSVC 14, Android 9.0.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+You can remove calls to this function.
 @end itemize
index 669b6804595ba5ec2a8bf646e10247b02122c9d5..1e0f150ef807764bb4ae8a26917acd099438406a 100644 (file)
@@ -18,4 +18,5 @@ Minix 3.1.8, mingw, MSVC 14, Android 4.4.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{random_r} from Gnulib module @code{random_r} instead.
 @end itemize
index cba471bd5422d29bcf90beb2683feec231b124a5..985da039178916af3a31be8257c9c47f597fef31 100644 (file)
@@ -18,4 +18,5 @@ mingw, MSVC 14.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the functions @code{timer_create} and @code{timer_settime} instead.
 @end itemize
index 1a7e22df6d397d7764c6c0058bd0e6f9660b3ea6..29b155a58819656e6b448fba71e4a5895e64ca26 100644 (file)
@@ -18,4 +18,5 @@ Minix 3.1.8, mingw, MSVC 14.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{setpgid} or @code{setsid} instead, as appropriate.
 @end itemize
index 3a926fbacb563a2d7e69bbff399b296b63eba9c4..0d78d865ef695a59090430d0d83f3f0ab887d03f 100644 (file)
@@ -18,4 +18,5 @@ FreeBSD 6.0, OpenBSD 6.7, Minix 3.1.8, mingw, MSVC 14, Android 7.1.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{sigprocmask} instead.
 @end itemize
index 1e8ef235bff449181c56458dbf313d86bb89f6ef..058d3e7bc923c3394f2f1f3fa2c7827b3ea136eb 100644 (file)
@@ -18,4 +18,5 @@ FreeBSD 6.0, OpenBSD 6.7, Minix 3.1.8, Cygwin 1.5.x, mingw, MSVC 14, Android 7.1
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{sigaction} instead.
 @end itemize
index 36c82be8c49982e468c771516ddbd40ce3b23902..6f7da931c00af08b9bbb20b71996e1113547a3b4 100644 (file)
@@ -18,6 +18,7 @@ Minix 3.1.8, mingw, MSVC 14.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{sigaction} instead.
 @end itemize
 
 Note: POSIX recommends using @code{sigaction} with SA_RESTART instead of
index 71377e63c8e75f9f83087c2b667504c463fa0c95..691e882cdb2ba66d57d21c2fef738f08cd50e6df 100644 (file)
@@ -20,4 +20,5 @@ Minix 3.1.8, mingw, MSVC 14, Android 7.1.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{sigsuspend} instead.
 @end itemize
index 42f4665dc987f1153e8489baa1a8fb0a1a0bcfcc..59edec2e6beb9c1d492c7409fa3ab31a94a16d5a 100644 (file)
@@ -18,4 +18,5 @@ FreeBSD 6.0, OpenBSD 6.7, Minix 3.1.8, mingw, MSVC 14, Android 7.1.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{sigprocmask} instead.
 @end itemize
index dba7838511066e65db77613d34d64a0bf4fa15d2..fcd864984feda20b64924480a70408a9befdcb46 100644 (file)
@@ -18,4 +18,5 @@ FreeBSD 6.0, OpenBSD 6.7, Minix 3.1.8, Cygwin 1.5.x, mingw, MSVC 14, Android 7.1
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{sigaction} instead.
 @end itemize
index e68b8d688ce7f8148661cbdac8c29bc9e63d9427..bb8a0408783c30906217c66026dfb72f0dc33050 100644 (file)
@@ -18,6 +18,7 @@ Minix 3.1.8.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the function @code{mkstemp} instead.
 @item
 This function is not appropriate for creating temporary files.  (It has
 security risks.)  Better use @code{mkstemp} instead.
index e12808b9e3095dea35d909f0121a3dab45a55b01..ff172d2646f1c16fbcd95681845756724358052f 100644 (file)
@@ -18,4 +18,5 @@ OpenBSD 6.7, Minix 3.1.8, Cygwin 2.9, mingw, MSVC 14, Android 9.0.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+Use the functions @code{getrlimit} and @code{setrlimit} instead.
 @end itemize
index 4c0bc7f3ed8d029714e95479ea8bfdb0a3f65765..ec89886099170242a39af61778f19a81a20b6d98 100644 (file)
@@ -34,4 +34,5 @@ instead.
 @item
 POSIX says this function is obsolescent and it is planned to be
 removed in POSIX 202x.
+You can use Gnulib module @code{utimens} instead.
 @end itemize