MFC r303486:

Mention that basename(3) and dirname(3) will change in the future.

  Update the existing manual pages for basename(3) and dirname(3) to
  mention that in future versions of FreeBSD, these functions will no
  longer use internal buffers for storing the results.

Approved by:	re@
This commit is contained in:
Ed Schouten 2016-08-05 05:50:27 +00:00
parent 0117d25d6a
commit 217f28eaa1
2 changed files with 16 additions and 7 deletions

View File

@ -16,7 +16,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd March 31, 2010
.Dd July 29, 2016
.Dt BASENAME 3
.Os
.Sh NAME
@ -61,8 +61,16 @@ function
returns a pointer to internal storage space allocated on the first call
that will be overwritten
by subsequent calls.
.Pp
Other vendor implementations of
.Fn basename
may store their result in the input buffer,
making it safe to use in multithreaded applications.
Future versions of
.Fx
will follow this approach as well.
.Fn basename_r
is therefore preferred for threaded applications.
will then become obsolete.
.Sh RETURN VALUES
On successful completion,
.Fn basename

View File

@ -16,7 +16,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 12, 2006
.Dd July 29, 2016
.Dt DIRNAME 3
.Os
.Sh NAME
@ -56,10 +56,11 @@ by subsequent calls.
.Pp
Other vendor implementations of
.Fn dirname
may modify the contents of the string passed to
.Fn dirname ;
this should be taken into account when writing code which calls this function
if portability is desired.
may store their result in the input buffer,
making it safe to use in multithreaded applications.
Future versions of
.Fx
will follow this approach as well.
.Sh RETURN VALUES
On successful completion,
.Fn dirname