osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 0
Code Issues Releases Wiki Activity

doc: clarify osmo_strlcpy() doc 

Stating that it 'truncates src' is misleading. Also clarify whether siz
includes the space needed for the terminating NUL.

Change-Id: I01c1a94408b471f7f54576178a60938bf9ee3261
This commit is contained in:
Neels Hofmeyr 2017-01-13 13:55:43 +01:00 committed by Harald Welte
parent 449324b264
commit df83eced68
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/utils.c
View File

@ -343,12 +343,12 @@ uint8_t *osmo_encode_big_endian(uint64_t value, size_t data_len)
/*! \brief Copy a C-string into a sized buffer
* \param[in] src source string
* \param[out] dst destination string
* \param[in] siz size of the \a dst string
* \returns length of source string
* \param[in] siz size of the \a dst buffer
* \returns length of \a src
*
* Copies up to \a siz characters from \a src to \a dst, but ensures
* that the last character of \a dst is always a NUL character. May
* truncate \a src to do achieve this.
* Copy at most \a siz bytes from \a src to \a dst, ensuring that the result is
* NUL terminated. The NUL character is included in \a siz, i.e. passing the
* actual sizeof(*dst) is correct.
*/
size_t osmo_strlcpy(char *dst, const char *src, size_t siz)
{