summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2020-12-08 14:59:28 -0500
committerNick Mathewson <nickm@torproject.org>2020-12-08 14:59:28 -0500
commitbaef0843a424116026f3f97185dae89271903041 (patch)
treeda4c1885084c6d4c94accf86247f8f7bee87b3a9 /src/lib
parentdbc8d2a4e476c06f59db3ff79b66afc8bc4ea27c (diff)
downloadtor-baef0843a424116026f3f97185dae89271903041.tar.gz
tor-baef0843a424116026f3f97185dae89271903041.zip
Fix a couple of documentation comments related to #40094
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/fs/conffile.c8
-rw-r--r--src/lib/sandbox/sandbox.c4
2 files changed, 7 insertions, 5 deletions
diff --git a/src/lib/fs/conffile.c b/src/lib/fs/conffile.c
index 1f58a3590c..acd8dfb8cc 100644
--- a/src/lib/fs/conffile.c
+++ b/src/lib/fs/conffile.c
@@ -53,10 +53,10 @@ config_get_lines_include(const char *string, config_line_t **result,
opened_lst, 1, NULL, config_process_include);
}
-/** Returns a list of paths obtained when expading globs in <b>pattern</b>. If
- * <b>pattern</b> has no globs, returns a list with <b>pattern</b> if it is an
- * existing path or NULL otherwise. If <b>opened_files</b> is provided, adds
- * paths opened by glob to it. Returns NULL on failure. */
+/** Return a list of paths obtained when expading globs in <b>pattern</b>.
+ * If <b>pattern</b> has no globs, return a list with <b>pattern</b> in it.
+ * If <b>opened_files</b> is provided, add paths opened by glob to it.
+ * Return NULL on failure. */
static smartlist_t *
expand_glob(const char *pattern, smartlist_t *opened_files)
{
diff --git a/src/lib/sandbox/sandbox.c b/src/lib/sandbox/sandbox.c
index d9ad8ec2c6..168dfd943c 100644
--- a/src/lib/sandbox/sandbox.c
+++ b/src/lib/sandbox/sandbox.c
@@ -1229,7 +1229,9 @@ static sandbox_filter_func_t filter_func[] = {
/**
* Return the interned (and hopefully sandbox-permitted) string equal
* to @a str.
- */
+ *
+ * Return NULL if `str` is NULL, or `str` is not an interned string.
+ **/
const char *
sandbox_intern_string(const char *str)
{