aboutsummaryrefslogtreecommitdiff
path: root/src/lib/version
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-11-06 14:40:20 -0500
committerNick Mathewson <nickm@torproject.org>2019-11-06 14:40:20 -0500
commit9687efb386141e5fc46ab295b32bf2dff1f9845b (patch)
tree78b2ff8497ec3532205b7247e7e2ac1ea7b3f6b3 /src/lib/version
parentb994397f1af193f841703151af846ac497bbc0f7 (diff)
downloadtor-9687efb386141e5fc46ab295b32bf2dff1f9845b.tar.gz
tor-9687efb386141e5fc46ab295b32bf2dff1f9845b.zip
Add a bunch of doxygen for things in src/lib.
Diffstat (limited to 'src/lib/version')
-rw-r--r--src/lib/version/git_revision.c6
-rw-r--r--src/lib/version/version.c4
2 files changed, 10 insertions, 0 deletions
diff --git a/src/lib/version/git_revision.c b/src/lib/version/git_revision.c
index e87620a20c..9ee49f0c37 100644
--- a/src/lib/version/git_revision.c
+++ b/src/lib/version/git_revision.c
@@ -23,6 +23,12 @@ const char tor_git_revision[] =
#endif
"";
+/**
+ * String appended to Tor bug messages describing the Tor version.
+ *
+ * It has the form "(on Tor 0.4.3.1-alpha)" or
+ * "(on Tor 0.4.3.1-alpha git-b994397f1af193f8)"
+ **/
const char tor_bug_suffix[] = " (on Tor " VERSION
#ifndef COCCI
#ifndef _MSC_VER
diff --git a/src/lib/version/version.c b/src/lib/version/version.c
index b2f25e97b5..b08d566e12 100644
--- a/src/lib/version/version.c
+++ b/src/lib/version/version.c
@@ -24,6 +24,10 @@ static const char the_short_tor_version[] =
#endif
"";
+/**
+ * Longest possible version length. We make this a constant so that we
+ * can statically allocate the_tor_version.
+ **/
#define MAX_VERSION_LEN 128
/** The version of this Tor process, possibly including git version */