aboutsummaryrefslogtreecommitdiff
path: root/src/or
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2008-11-10 20:40:01 +0000
committerNick Mathewson <nickm@torproject.org>2008-11-10 20:40:01 +0000
commit6c50ab6e61f952714cfee5de76e471036cb924d7 (patch)
tree77616b8ded7139b9724d8872e3c26d4a76e22e43 /src/or
parent90e832a5dbb5297e7a77c5e2c0a0c047a160eb0f (diff)
downloadtor-6c50ab6e61f952714cfee5de76e471036cb924d7.tar
tor-6c50ab6e61f952714cfee5de76e471036cb924d7.tar.gz
Document a couple of functions.
svn:r17239
Diffstat (limited to 'src/or')
-rw-r--r--src/or/main.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/or/main.c b/src/or/main.c
index c65a5a3a5..2d3cc72c6 100644
--- a/src/or/main.c
+++ b/src/or/main.c
@@ -1861,7 +1861,11 @@ tor_init(int argc, char *argv[])
static tor_lockfile_t *lockfile = NULL;
-/** DOCDOC. What's this function do? */
+/** Try to grab the lock file described in <b>options</b>, if we do not
+ * already have it. If <b>err_if_locked</b> is true, warn if somebody else is
+ * holding the lock, and exit if we can't get it after waiting. Otherwise,
+ * return -1 if we can't get the lockfile. Return 0 on success.
+ */
int
try_locking(or_options_t *options, int err_if_locked)
{