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

dirname(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:56:57 +00:00
parent a966418a66
commit 3d54bd2294
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=318700
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/libc/gen/dirname.3
View File

@ -37,6 +37,16 @@ Any trailing
.Sq \&/
characters are not counted as part of the directory
name.
.Sh IMPLEMENTATION NOTES
This implementation of
.Fn dirname
uses the buffer provided by the caller to store the resulting parent
directory.
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 @@ signifying the current directory.
Otherwise,
it returns a pointer to the parent directory of
.Fa path .
.Sh IMPLEMENTATION NOTES
This implementation of
.Fn dirname
uses the buffer provided by the caller to store the resulting parent
directory.
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 ,