d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

basename(3): fix section ordering

Browse Source 
IMPLEMENTATION NOTES come before RETURN VALUES

MFC after:	2 weeks
Reported by:	make manlint
Sponsored by:	Dell EMC Isilon
This commit is contained in:
Enji Cooper 2017-05-23 06:53:31 +00:00
parent 7a0466bc2b
commit 41a9662896
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=318698
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lib/libc/gen/basename.3
View File

@ -16,7 +16,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 29, 2016
.Dd May 22, 2017
.Dt BASENAME 3
.Os
.Sh NAME
@ -34,6 +34,16 @@ function returns the last component from the pathname pointed to by
deleting any trailing
.Sq \&/
characters.
.Sh IMPLEMENTATION NOTES
This implementation of
.Fn basename
uses the buffer provided by the caller to store the resulting pathname
component.
Other vendor implementations may return a pointer to internal storage
space instead.
The advantage of the former approach is that it ensures thread-safety,
while also placing no upper limit on the supported length of the
pathname.
.Sh RETURN VALUES
If
.Fa path
@ -50,16 +60,6 @@ is returned.
Otherwise,
it returns a pointer to the last component of
.Fa path .
.Sh IMPLEMENTATION NOTES
This implementation of
.Fn basename
uses the buffer provided by the caller to store the resulting pathname
component.
Other vendor implementations may return a pointer to internal storage
space instead.
The advantage of the former approach is that it ensures thread-safety,
while also placing no upper limit on the supported length of the
pathname.
.Sh SEE ALSO
.Xr basename 1 ,
.Xr dirname 1 ,