ariadne
/
pkgconf
3
6
Fork 4
Code Issues 6 Pull Requests 2 Projects Releases 2 Wiki Activity

doc: document pkgconf_path_relocate()

pull/109/head
William Pitcock 2017-01-19 10:31:40 -06:00
parent 4a3d3745e0
commit 0315832285
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/libpkgconf-path.rst
View File

@ -52,3 +52,12 @@ variables.
:param pkgconf_list_t* dirlist: The path list to clean up. :param pkgconf_list_t* dirlist: The path list to clean up.
:return: nothing :return: nothing
.. c:function:: bool pkgconf_path_relocate(char *buf, size_t buflen)
Relocates a path, possibly calling realpath() or cygwin_conv_path() on it.
:param char* buf: The path to relocate.
:param size_t buflen: The buffer length the path is contained in.
:return: true on success, false on error
:rtype: bool

12
libpkgconf/path.c
View File

@ -225,6 +225,18 @@ pkgconf_path_free(pkgconf_list_t *dirlist)
} }
} }
/*
* !doc
*
* .. c:function:: bool pkgconf_path_relocate(char *buf, size_t buflen)
*
* Relocates a path, possibly calling realpath() or cygwin_conv_path() on it.
*
* :param char* buf: The path to relocate.
* :param size_t buflen: The buffer length the path is contained in.
* :return: true on success, false on error
* :rtype: bool
*/
bool bool
pkgconf_path_relocate(char *buf, size_t buflen) pkgconf_path_relocate(char *buf, size_t buflen)
{ {