[tor-commits] [tor/master] Move all use cases of micro-revision.i to a single place

[nickm at torproject.org]

commit 5aee26ee46d8d38759713d00ce4310a3aef4a559
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Jul 11 09:52:39 2018 -0400

    Move all use cases of micro-revision.i to a single place
    
    That place is git-revision.c; git-revision.c now lives in lib/log.
    
    Also fix the compilation rules so that all object files that need
    micro-revision.i depend on it.
---
 src/app/config/config.c                 |  2 +-
 src/core/include.am                     |  6 ------
 src/{core/or => lib/log}/git_revision.c | 10 +++++++++-
 src/{core/or => lib/log}/git_revision.h |  2 +-
 src/lib/log/include.am                  |  9 +++++++--
 src/lib/log/log.c                       | 14 ++++----------
 6 files changed, 22 insertions(+), 21 deletions(-)

diff --git a/src/app/config/config.c b/src/app/config/config.c
index 1be1803f2..74aa64ded 100644
--- a/src/app/config/config.c
+++ b/src/app/config/config.c
@@ -85,7 +85,7 @@
 #include "feature/relay/dns.h"
 #include "core/or/dos.h"
 #include "feature/client/entrynodes.h"
-#include "core/or/git_revision.h"
+#include "lib/log/git_revision.h"
 #include "feature/stats/geoip.h"
 #include "feature/hibernate/hibernate.h"
 #include "core/mainloop/main.h"
diff --git a/src/core/include.am b/src/core/include.am
index 1f37044e9..cd9edc449 100644
--- a/src/core/include.am
+++ b/src/core/include.am
@@ -34,7 +34,6 @@ LIBTOR_APP_A_SOURCES = 				\
 	src/core/or/connection_edge.c		\
 	src/core/or/connection_or.c		\
 	src/core/or/dos.c			\
-	src/core/or/git_revision.c		\
 	src/core/or/policies.c			\
 	src/core/or/protover.c			\
 	src/core/or/reasons.c			\
@@ -135,10 +134,6 @@ else
 src_core_libtor_app_testing_a_SOURCES =
 endif
 
-src/core/or/git_revision.$(OBJEXT) \
-  src/core/or/src_core_libtor_app_testing_a-git_revision.$(OBJEXT): \
-	micro-revision.i
-
 AM_CPPFLAGS += -DSHARE_DATADIR="\"$(datadir)\""		\
 		-DLOCALSTATEDIR="\"$(localstatedir)\""	\
 		-DBINDIR="\"$(bindir)\""
@@ -190,7 +185,6 @@ noinst_HEADERS +=					\
 	src/core/or/entry_connection_st.h		\
 	src/core/or/entry_port_cfg_st.h			\
 	src/core/or/extend_info_st.h			\
-	src/core/or/git_revision.h			\
 	src/core/or/listener_connection_st.h		\
 	src/core/or/or.h				\
 	src/core/or/or_circuit_st.h			\
diff --git a/src/core/or/git_revision.c b/src/lib/log/git_revision.c
similarity index 73%
rename from src/core/or/git_revision.c
rename to src/lib/log/git_revision.c
index 28ec1a793..9d29ecd2a 100644
--- a/src/core/or/git_revision.c
+++ b/src/lib/log/git_revision.c
@@ -3,7 +3,8 @@
  * Copyright (c) 2007-2018, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
-#include "core/or/git_revision.h"
+#include "orconfig.h"
+#include "lib/log/git_revision.h"
 
 /** String describing which Tor Git repository version the source was
  * built from.  This string is generated by a bit of shell kludging in
@@ -14,3 +15,10 @@ const char tor_git_revision[] =
 #include "micro-revision.i"
 #endif
   "";
+
+const char tor_bug_suffix[] = " (on Tor " VERSION
+#ifndef _MSC_VER
+  " "
+#include "micro-revision.i"
+#endif
+  ")";
diff --git a/src/core/or/git_revision.h b/src/lib/log/git_revision.h
similarity index 90%
rename from src/core/or/git_revision.h
rename to src/lib/log/git_revision.h
index 02070cfd5..0ce119079 100644
--- a/src/core/or/git_revision.h
+++ b/src/lib/log/git_revision.h
@@ -7,6 +7,6 @@
 #define TOR_GIT_REVISION_H
 
 extern const char tor_git_revision[];
+extern const char tor_bug_suffix[];
 
 #endif /* !defined(TOR_GIT_REVISION_H) */
-
diff --git a/src/lib/log/include.am b/src/lib/log/include.am
index b5a1c5ca2..4a6c9b368 100644
--- a/src/lib/log/include.am
+++ b/src/lib/log/include.am
@@ -7,6 +7,7 @@ endif
 
 src_lib_libtor_log_a_SOURCES =			\
 	src/lib/log/escape.c			\
+        src/lib/log/git_revision.c              \
 	src/lib/log/ratelim.c			\
 	src/lib/log/log.c			\
 	src/lib/log/util_bug.c
@@ -20,11 +21,15 @@ src_lib_libtor_log_testing_a_SOURCES = \
 src_lib_libtor_log_testing_a_CPPFLAGS = $(AM_CPPFLAGS) $(TEST_CPPFLAGS)
 src_lib_libtor_log_testing_a_CFLAGS = $(AM_CFLAGS) $(TEST_CFLAGS)
 
-src/lib/log/torlog.$(OBJEXT) \
-  src/lib/log/src_lib_libtor_log_testing_a-torlog.$(OBJEXT): micro-revision.i
+# Declare that these object files depend on micro-revision.i.  Without this
+# rule, we could try to build them before micro-revision.i was created.
+src/lib/log/git_revision.$(OBJEXT) \
+  src/lib/log/src_lib_libtor_log_testing_a-git_revision.$(OBJEXT): \
+	micro-revision.i
 
 noinst_HEADERS +=					\
 	src/lib/log/escape.h				\
+        src/lib/log/git_revision.h                      \
 	src/lib/log/ratelim.h				\
 	src/lib/log/log.h				\
 	src/lib/log/util_bug.h				\
diff --git a/src/lib/log/log.c b/src/lib/log/log.c
index 8349041ab..e2514a341 100644
--- a/src/lib/log/log.c
+++ b/src/lib/log/log.c
@@ -32,6 +32,7 @@
 
 #define LOG_PRIVATE
 #include "lib/log/log.h"
+#include "lib/log/git_revision.h"
 #include "lib/log/ratelim.h"
 #include "lib/lock/compat_mutex.h"
 #include "lib/smartlist_core/smartlist_core.h"
@@ -353,13 +354,6 @@ log_tor_version(logfile_t *lf, int reset)
   return 0;
 }
 
-static const char bug_suffix[] = " (on Tor " VERSION
-#ifndef _MSC_VER
-  " "
-#include "micro-revision.i"
-#endif
-  ")";
-
 /** Helper: Format a log message into a fixed-sized buffer. (This is
  * factored out of <b>logv</b> so that we never format a message more
  * than once.)  Return a pointer to the first character of the message
@@ -442,9 +436,9 @@ format_msg(char *buf, size_t buf_len,
   }
 
   if (domain == LD_BUG &&
-      buf_len - n > strlen(bug_suffix)+1) {
-    memcpy(buf+n, bug_suffix, strlen(bug_suffix));
-    n += strlen(bug_suffix);
+      buf_len - n > strlen(tor_bug_suffix)+1) {
+    memcpy(buf+n, tor_bug_suffix, strlen(tor_bug_suffix));
+    n += strlen(tor_bug_suffix);
   }
 
   buf[n]='\n';