Skip to content

Commit a76cfc2

Browse files
committed
[clang-tidy] Update documentation of check bugprone-unused-return-value [NFC].
The list of checked functions was incomplete in the description. Reviewed By: aaron.ballman, steakhal Differential Revision: https://reviews.llvm.org/D111623
1 parent 97d67f7 commit a76cfc2

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

clang-tools-extra/docs/clang-tidy/checks/bugprone-unused-return-value.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,25 @@ Options
1010

1111
.. option:: CheckedFunctions
1212

13-
Semicolon-separated list of functions to check. Defaults to
14-
``::std::async;::std::launder;::std::remove;::std::remove_if;::std::unique;::std::unique_ptr::release;::std::basic_string::empty;::std::vector::empty``.
15-
This means that the calls to following functions are checked by default:
13+
Semicolon-separated list of functions to check. The function is checked if
14+
the name and scope matches, with any arguments.
15+
By default the following functions are checked:
16+
``std::async, std::launder, std::remove, std::remove_if, std::unique,
17+
std::unique_ptr::release, std::basic_string::empty, std::vector::empty,
18+
std::back_inserter, std::distance, std::find, std::find_if, std::inserter,
19+
std::lower_bound, std::make_pair, std::map::count, std::map::find,
20+
std::map::lower_bound, std::multimap::equal_range,
21+
std::multimap::upper_bound, std::set::count, std::set::find, std::setfill,
22+
std::setprecision, std::setw, std::upper_bound, std::vector::at,
23+
bsearch, ferror, feof, isalnum, isalpha, isblank, iscntrl, isdigit, isgraph,
24+
islower, isprint, ispunct, isspace, isupper, iswalnum, iswprint, iswspace,
25+
isxdigit, memchr, memcmp, strcmp, strcoll, strncmp, strpbrk, strrchr,
26+
strspn, strstr, wcscmp, access, bind, connect, difftime, dlsym, fnmatch,
27+
getaddrinfo, getopt, htonl, htons, iconv_open, inet_addr, isascii, isatty,
28+
mmap, newlocale, openat, pathconf, pthread_equal, pthread_getspecific,
29+
pthread_mutex_trylock, readdir, readlink, recvmsg, regexec, scandir,
30+
semget, setjmp, shm_open, shmget, sigismember, strcasecmp, strsignal,
31+
ttyname``
1632

1733
- ``std::async()``. Not using the return value makes the call synchronous.
1834
- ``std::launder()``. Not using the return value usually means that the

0 commit comments

Comments
 (0)