[tor/master] clean/extend some module docs, including fix from #18403

commit 9fc472e1a8a53a18dfbd5c9cde2f1c268c335e96 Author: Nick Mathewson <nickm@torproject.org> Date: Sun Feb 28 17:57:47 2016 +0100 clean/extend some module docs, including fix from #18403 --- src/common/backtrace.c | 5 +++++ src/common/compat.c | 2 +- src/common/crypto.c | 3 ++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/common/backtrace.c b/src/common/backtrace.c index eac54e0..3b762b6 100644 --- a/src/common/backtrace.c +++ b/src/common/backtrace.c @@ -6,6 +6,11 @@ * * \brief Functions to produce backtraces on bugs, crashes, or assertion * failures. + * + * Currently, we've only got an implementation here using the backtrace() + * family of functions, which are sometimes provided by libc and sometimes + * provided by libexecinfo. We tie into the sigaction() backend in order to + * detect crashes. */ #define __USE_GNU diff --git a/src/common/compat.c b/src/common/compat.c index 6f3e1e6..af61f02 100644 --- a/src/common/compat.c +++ b/src/common/compat.c @@ -6,7 +6,7 @@ /** * \file compat.c * \brief Wrappers to make calls more portable. This code defines - * functions such as tor_malloc, tor_snprintf, get/set various data types, + * functions such as tor_snprintf, get/set various data types, * renaming, setting socket options, switching user IDs. It is basically * where the non-portable items are conditionally included depending on * the platform. diff --git a/src/common/crypto.c b/src/common/crypto.c index b031624..11f8e1d 100644 --- a/src/common/crypto.c +++ b/src/common/crypto.c @@ -7,7 +7,8 @@ /** * \file crypto.c * \brief Wrapper functions to present a consistent interface to - * public-key and symmetric cryptography operations from OpenSSL. + * public-key and symmetric cryptography operations from OpenSSL and + * other places. **/ #include "orconfig.h"
participants (1)
-
nickm@torproject.org