Makefile.am 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  1. # Copyright (c) 2001-2004, Roger Dingledine
  2. # Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson
  3. # Copyright (c) 2007-2019, The Tor Project, Inc.
  4. # See LICENSE for licensing information
  5. ACLOCAL_AMFLAGS = -I m4
  6. noinst_LIBRARIES=
  7. EXTRA_DIST=
  8. noinst_HEADERS=
  9. bin_PROGRAMS=
  10. EXTRA_PROGRAMS=
  11. CLEANFILES=
  12. TESTS=
  13. noinst_PROGRAMS=
  14. DISTCLEANFILES=
  15. bin_SCRIPTS=
  16. AM_CPPFLAGS=\
  17. -I$(top_srcdir)/src \
  18. -I$(top_srcdir)/src/ext \
  19. -I$(top_srcdir)/src/ext/trunnel \
  20. -I$(top_srcdir)/src/trunnel
  21. AM_CFLAGS= \
  22. @TOR_SYSTEMD_CFLAGS@ \
  23. @CFLAGS_BUGTRAP@ \
  24. @TOR_LZMA_CFLAGS@ \
  25. @TOR_ZSTD_CFLAGS@
  26. SHELL=@SHELL@
  27. if COVERAGE_ENABLED
  28. TESTING_TOR_BINARY=$(top_builddir)/src/app/tor-cov$(EXEEXT)
  29. else
  30. TESTING_TOR_BINARY=$(top_builddir)/src/app/tor$(EXEEXT)
  31. endif
  32. if USE_RUST
  33. rust_ldadd=$(top_builddir)/$(TOR_RUST_LIB_PATH)
  34. else
  35. rust_ldadd=
  36. endif
  37. # "Common" libraries used to link tor's utility code.
  38. TOR_UTIL_LIBS = \
  39. src/lib/libtor-geoip.a \
  40. src/lib/libtor-process.a \
  41. src/lib/libtor-buf.a \
  42. src/lib/libtor-confmgt.a \
  43. src/lib/libtor-pubsub.a \
  44. src/lib/libtor-dispatch.a \
  45. src/lib/libtor-time.a \
  46. src/lib/libtor-fs.a \
  47. src/lib/libtor-encoding.a \
  48. src/lib/libtor-sandbox.a \
  49. src/lib/libtor-container.a \
  50. src/lib/libtor-net.a \
  51. src/lib/libtor-thread.a \
  52. src/lib/libtor-memarea.a \
  53. src/lib/libtor-math.a \
  54. src/lib/libtor-meminfo.a \
  55. src/lib/libtor-osinfo.a \
  56. src/lib/libtor-log.a \
  57. src/lib/libtor-lock.a \
  58. src/lib/libtor-fdio.a \
  59. src/lib/libtor-string.a \
  60. src/lib/libtor-term.a \
  61. src/lib/libtor-smartlist-core.a \
  62. src/lib/libtor-malloc.a \
  63. src/lib/libtor-wallclock.a \
  64. src/lib/libtor-err.a \
  65. src/lib/libtor-version.a \
  66. src/lib/libtor-intmath.a \
  67. src/lib/libtor-ctime.a
  68. # Variants of the above for linking the testing variant of tor (for coverage
  69. # and tests)
  70. if UNITTESTS_ENABLED
  71. TOR_UTIL_TESTING_LIBS = \
  72. src/lib/libtor-geoip-testing.a \
  73. src/lib/libtor-process-testing.a \
  74. src/lib/libtor-buf-testing.a \
  75. src/lib/libtor-confmgt-testing.a \
  76. src/lib/libtor-pubsub-testing.a \
  77. src/lib/libtor-dispatch-testing.a \
  78. src/lib/libtor-time-testing.a \
  79. src/lib/libtor-fs-testing.a \
  80. src/lib/libtor-encoding-testing.a \
  81. src/lib/libtor-sandbox-testing.a \
  82. src/lib/libtor-container-testing.a \
  83. src/lib/libtor-net-testing.a \
  84. src/lib/libtor-thread-testing.a \
  85. src/lib/libtor-memarea-testing.a \
  86. src/lib/libtor-math-testing.a \
  87. src/lib/libtor-meminfo-testing.a \
  88. src/lib/libtor-osinfo-testing.a \
  89. src/lib/libtor-term-testing.a \
  90. src/lib/libtor-log-testing.a \
  91. src/lib/libtor-lock-testing.a \
  92. src/lib/libtor-fdio-testing.a \
  93. src/lib/libtor-string-testing.a \
  94. src/lib/libtor-smartlist-core-testing.a \
  95. src/lib/libtor-malloc-testing.a \
  96. src/lib/libtor-wallclock-testing.a \
  97. src/lib/libtor-err-testing.a \
  98. src/lib/libtor-version-testing.a \
  99. src/lib/libtor-intmath.a \
  100. src/lib/libtor-ctime-testing.a
  101. endif
  102. # Internal crypto libraries used in Tor
  103. TOR_CRYPTO_LIBS = \
  104. src/lib/libtor-tls.a \
  105. src/lib/libtor-crypt-ops.a \
  106. $(LIBKECCAK_TINY) \
  107. $(LIBDONNA)
  108. # Variants of the above for linking the testing variant of tor (for coverage
  109. # and tests)
  110. if UNITTESTS_ENABLED
  111. TOR_CRYPTO_TESTING_LIBS = \
  112. src/lib/libtor-tls-testing.a \
  113. src/lib/libtor-crypt-ops-testing.a \
  114. $(LIBKECCAK_TINY) \
  115. $(LIBDONNA)
  116. endif
  117. # All static libraries used to link tor.
  118. TOR_INTERNAL_LIBS = \
  119. src/core/libtor-app.a \
  120. src/lib/libtor-compress.a \
  121. src/lib/libtor-evloop.a \
  122. $(TOR_CRYPTO_LIBS) \
  123. $(TOR_UTIL_LIBS) \
  124. src/trunnel/libor-trunnel.a \
  125. src/lib/libtor-trace.a
  126. # Variants of the above for linking the testing variant of tor (for coverage
  127. # and tests)
  128. if UNITTESTS_ENABLED
  129. TOR_INTERNAL_TESTING_LIBS = \
  130. src/core/libtor-app-testing.a \
  131. src/lib/libtor-compress-testing.a \
  132. src/lib/libtor-evloop-testing.a \
  133. $(TOR_CRYPTO_TESTING_LIBS) \
  134. $(TOR_UTIL_TESTING_LIBS) \
  135. src/trunnel/libor-trunnel-testing.a \
  136. src/lib/libtor-trace.a
  137. endif
  138. TOR_LDFLAGS_CRYPTLIB=@TOR_LDFLAGS_openssl@
  139. TOR_LIBS_CRYPTLIB=@TOR_OPENSSL_LIBS@
  140. TOR_CFLAGS_CRYPTLIB=
  141. if USE_NSS
  142. TOR_CFLAGS_CRYPTLIB+=@NSS_CFLAGS@
  143. TOR_LIBS_CRYPTLIB+=@NSS_LIBS@
  144. endif
  145. # All libraries used to link tor-cov
  146. include src/include.am
  147. include doc/include.am
  148. include contrib/include.am
  149. manpages: $(nodist_man1_MANS)
  150. EXTRA_DIST+= \
  151. ChangeLog \
  152. CONTRIBUTING \
  153. CODE_OF_CONDUCT \
  154. INSTALL \
  155. LICENSE \
  156. Makefile.nmake \
  157. README \
  158. ReleaseNotes \
  159. scripts/maint/checkIncludes.py \
  160. scripts/maint/checkSpace.pl \
  161. scripts/maint/checkSpaceTest.sh \
  162. scripts/maint/checkspace_tests/dubious.c \
  163. scripts/maint/checkspace_tests/dubious.h \
  164. scripts/maint/checkspace_tests/expected.txt \
  165. scripts/maint/checkspace_tests/good_guard.h \
  166. scripts/maint/checkspace_tests/same_guard.h \
  167. scripts/maint/checkspace_tests/subdir/dubious.c \
  168. scripts/maint/checkShellScripts.sh \
  169. scripts/maint/practracker/README \
  170. scripts/maint/practracker/exceptions.txt \
  171. scripts/maint/practracker/includes.py \
  172. scripts/maint/practracker/metrics.py \
  173. scripts/maint/practracker/practracker.py \
  174. scripts/maint/practracker/practracker_tests.py \
  175. scripts/maint/practracker/problem.py \
  176. scripts/maint/practracker/testdata/.may_include \
  177. scripts/maint/practracker/testdata/a.c \
  178. scripts/maint/practracker/testdata/b.c \
  179. scripts/maint/practracker/testdata/ex0-expected.txt \
  180. scripts/maint/practracker/testdata/ex0.txt \
  181. scripts/maint/practracker/testdata/ex1-expected.txt \
  182. scripts/maint/practracker/testdata/ex1.txt \
  183. scripts/maint/practracker/testdata/ex1-overbroad-expected.txt \
  184. scripts/maint/practracker/testdata/ex1-regen-expected.txt \
  185. scripts/maint/practracker/testdata/ex1-regen-overbroad-expected.txt \
  186. scripts/maint/practracker/testdata/ex.txt \
  187. scripts/maint/practracker/testdata/header.h \
  188. scripts/maint/practracker/testdata/not_c_file \
  189. scripts/maint/practracker/test_practracker.sh \
  190. scripts/maint/practracker/util.py \
  191. scripts/coccinelle/apply.sh \
  192. scripts/coccinelle/check_cocci_parse.sh \
  193. scripts/coccinelle/exceptions.txt \
  194. scripts/coccinelle/test-operator-cleanup \
  195. scripts/coccinelle/tor-coccinelle.h \
  196. scripts/coccinelle/try_parse.sh
  197. ## This tells etags how to find mockable function definitions.
  198. AM_ETAGSFLAGS=--regex='{c}/MOCK_IMPL([^,]+,\W*\([a-zA-Z0-9_]+\)\W*,/\1/s'
  199. if COVERAGE_ENABLED
  200. TEST_CFLAGS=-fno-inline -fprofile-arcs -ftest-coverage
  201. if DISABLE_ASSERTS_IN_UNIT_TESTS
  202. TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE -DDISABLE_ASSERTS_IN_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
  203. else
  204. TEST_CPPFLAGS=-DTOR_UNIT_TESTS -DTOR_COVERAGE @TOR_MODULES_ALL_ENABLED@
  205. endif
  206. TEST_NETWORK_FLAGS=--coverage --hs-multi-client 1
  207. else
  208. TEST_CFLAGS=
  209. TEST_CPPFLAGS=-DTOR_UNIT_TESTS @TOR_MODULES_ALL_ENABLED@
  210. TEST_NETWORK_FLAGS=--hs-multi-client 1
  211. endif
  212. TEST_NETWORK_SHOW_WARNINGS_FOR_LAST_RUN_FLAGS=--quiet --only-warnings
  213. if LIBFUZZER_ENABLED
  214. TEST_CFLAGS += -fsanitize-coverage=trace-pc-guard,trace-cmp,trace-div
  215. # not "edge"
  216. endif
  217. TEST_NETWORK_ALL_LOG_DIR=$(top_builddir)/test_network_log
  218. TEST_NETWORK_ALL_DRIVER_FLAGS=--color-tests yes
  219. #install-data-local:
  220. # $(INSTALL) -m 755 -d $(LOCALSTATEDIR)/lib/tor
  221. # Allows to override rpmbuild with rpmbuild-md5 from fedora-packager so that
  222. # building for EL5 won't fail on https://bugzilla.redhat.com/show_bug.cgi?id=490613
  223. RPMBUILD ?= rpmbuild
  224. # Use automake's dist-gzip target to build the tarball
  225. dist-rpm: dist-gzip
  226. TIMESTAMP=$$(date +"%Y-%m-%d_%H.%M.%S"); \
  227. RPM_BUILD_DIR=$$(mktemp -d "/tmp/tor-rpm-build-$$TIMESTAMP-XXXX"); \
  228. mkdir -p "$$RPM_BUILD_DIR"/{BUILD,RPMS,SOURCES/"tor-$(VERSION)",SPECS,SRPMS}; \
  229. cp -fa "$(distdir).tar.gz" "$$RPM_BUILD_DIR"/SOURCES/; \
  230. LIBS=-lrt $(RPMBUILD) -ba --define "_topdir $$RPM_BUILD_DIR" tor.spec; \
  231. cp -fa "$$RPM_BUILD_DIR"/SRPMS/* .; \
  232. cp -fa "$$RPM_BUILD_DIR"/RPMS/* .; \
  233. rm -rf "$$RPM_BUILD_DIR"; \
  234. echo "RPM build finished"; \
  235. #end of dist-rpm
  236. .PHONY: doxygen
  237. doxygen: Doxyfile
  238. mkdir -p doc/doxygen
  239. (cd "$(top_srcdir)" && doxygen "$(abs_top_builddir)/Doxyfile")
  240. test: all
  241. $(top_builddir)/src/test/test
  242. shellcheck:
  243. $(top_srcdir)/scripts/maint/checkShellScripts.sh
  244. check-local: \
  245. check-spaces \
  246. check-changes \
  247. check-includes \
  248. shellcheck
  249. need-chutney-path:
  250. @if test ! -d "$$CHUTNEY_PATH"; then \
  251. echo '$$CHUTNEY_PATH was not set.'; \
  252. if test -d $(top_srcdir)/../chutney -a -x $(top_srcdir)/../chutney/chutney; then \
  253. echo "Assuming test-network.sh will find" $(top_srcdir)/../chutney; \
  254. else \
  255. echo; \
  256. echo "To run these tests, git clone https://git.torproject.org/chutney.git ; export CHUTNEY_PATH=\`pwd\`/chutney"; \
  257. exit 1; \
  258. fi \
  259. fi
  260. # Note that test-network requires a copy of Chutney in $CHUTNEY_PATH.
  261. # Chutney can be cloned from https://git.torproject.org/chutney.git .
  262. test-network: need-chutney-path $(TESTING_TOR_BINARY) src/tools/tor-gencert
  263. $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_FLAGS)
  264. # Run all available tests using automake's test-driver
  265. # - only run IPv6 tests if we can ping6 or ping -6 ::1 (localhost)
  266. # we try the syntax for BSD ping6, Linux ping6, and Linux ping -6,
  267. # because they're incompatible
  268. # - some IPv6 tests may fail without an IPv6 DNS server
  269. # (see #16971 and #17011)
  270. # - only run mixed tests if we have a tor-stable binary
  271. # - show tor warnings on the console after each network run
  272. # (otherwise, warnings go to the logs, and people don't see them unless
  273. # there is a network failure)
  274. test-network-all: need-chutney-path test-driver $(TESTING_TOR_BINARY) src/tools/tor-gencert
  275. mkdir -p $(TEST_NETWORK_ALL_LOG_DIR)
  276. rm -f $(TEST_NETWORK_ALL_LOG_DIR)/*.log $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
  277. @flavors="$(TEST_CHUTNEY_FLAVORS)"; \
  278. if ping6 -q -c 1 -o ::1 >/dev/null 2>&1 || ping6 -q -c 1 -W 1 ::1 >/dev/null 2>&1 || ping -6 -c 1 -W 1 ::1 >/dev/null 2>&1; then \
  279. echo "ping6 ::1 or ping ::1 succeeded, running IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
  280. flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
  281. else \
  282. echo "ping6 ::1 and ping ::1 failed, skipping IPv6 flavors: $(TEST_CHUTNEY_FLAVORS_IPV6)."; \
  283. skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_IPV6)"; \
  284. fi; \
  285. if command -v tor-stable >/dev/null 2>&1; then \
  286. echo "tor-stable found, running mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
  287. flavors="$$flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
  288. else \
  289. echo "tor-stable not found, skipping mixed flavors: $(TEST_CHUTNEY_FLAVORS_MIXED)."; \
  290. skip_flavors="$$skip_flavors $(TEST_CHUTNEY_FLAVORS_MIXED)"; \
  291. fi; \
  292. for f in $$skip_flavors; do \
  293. echo "SKIP: $$f"; \
  294. done; \
  295. for f in $$flavors; do \
  296. $(SHELL) $(top_srcdir)/test-driver --test-name $$f --log-file $(TEST_NETWORK_ALL_LOG_DIR)/$$f.log --trs-file $(TEST_NETWORK_ALL_LOG_DIR)/$$f.trs $(TEST_NETWORK_ALL_DRIVER_FLAGS) $(top_srcdir)/src/test/test-network.sh --flavor $$f $(TEST_NETWORK_FLAGS); \
  297. $(top_srcdir)/src/test/test-network.sh $(TEST_NETWORK_SHOW_WARNINGS_FOR_LAST_RUN_FLAGS); \
  298. done; \
  299. echo "Log and result files are available in $(TEST_NETWORK_ALL_LOG_DIR)."; \
  300. ! grep -q FAIL $(TEST_NETWORK_ALL_LOG_DIR)/*.trs
  301. need-stem-path:
  302. @if test ! -d "$$STEM_SOURCE_DIR"; then \
  303. echo '$$STEM_SOURCE_DIR was not set.'; echo; \
  304. echo "To run these tests, git clone https://git.torproject.org/stem.git/ ; export STEM_SOURCE_DIR=\`pwd\`/stem"; \
  305. exit 1; \
  306. fi
  307. test-stem: need-stem-path $(TESTING_TOR_BINARY)
  308. @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --integ --test control.controller --test control.base_controller --test process --log notice;
  309. test-stem-full: need-stem-path $(TESTING_TOR_BINARY)
  310. @$(PYTHON) "$$STEM_SOURCE_DIR"/run_tests.py --tor "$(TESTING_TOR_BINARY)" --all --log notice --target RUN_ALL,ONLINE -v;
  311. test-full: \
  312. need-stem-path \
  313. need-chutney-path \
  314. check \
  315. test-network \
  316. test-stem
  317. test-full-online: \
  318. need-stem-path \
  319. need-chutney-path \
  320. check \
  321. test-network \
  322. test-stem-full
  323. # We can't delete the gcno files, because they are created when tor is compiled
  324. reset-gcov:
  325. rm -f $(top_builddir)/src/*/*.gcda $(top_builddir)/src/*/*/*.gcda \
  326. $(top_builddir)/src/*/*.gcov $(top_builddir)/src/*/*/*.gcov
  327. HTML_COVER_DIR=$(top_builddir)/coverage_html
  328. coverage-html: all
  329. if COVERAGE_ENABLED
  330. test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
  331. test -d "$(HTML_COVER_DIR)" || $(MKDIR_P) "$(HTML_COVER_DIR)"
  332. lcov --rc lcov_branch_coverage=1 --directory $(top_builddir)/src --zerocounters
  333. $(MAKE) reset-gcov
  334. $(MAKE) check
  335. lcov --capture --rc lcov_branch_coverage=1 --no-external --directory $(top_builddir) --base-directory $(top_srcdir) --output-file "$(HTML_COVER_DIR)/lcov.tmp"
  336. lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
  337. genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
  338. else
  339. @printf "Not configured with --enable-coverage, run ./configure --enable-coverage\n"
  340. endif
  341. coverage-html-full: all
  342. test -e "`which lcov`" || (echo "lcov must be installed. See <http://ltp.sourceforge.net/coverage/lcov.php>." && false)
  343. test -d "$(HTML_COVER_DIR)" || mkdir -p "$(HTML_COVER_DIR)"
  344. lcov --rc lcov_branch_coverage=1 --directory ./src --zerocounters
  345. $(MAKE) reset-gcov
  346. $(MAKE) check
  347. $(MAKE) test-stem-full
  348. CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh
  349. CHUTNEY_TOR=tor-cov CHUTNEY_TOR_GENCERT=tor-cov-gencert $(top_srcdir)/src/test/test-network.sh --flavor hs
  350. lcov --capture --rc lcov_branch_coverage=1 --no-external --directory . --output-file "$(HTML_COVER_DIR)/lcov.tmp"
  351. lcov --remove "$(HTML_COVER_DIR)/lcov.tmp" --rc lcov_branch_coverage=1 'test/*' 'ext/tinytest*' '/usr/*' --output-file "$(HTML_COVER_DIR)/lcov.info"
  352. genhtml --branch-coverage -o "$(HTML_COVER_DIR)" "$(HTML_COVER_DIR)/lcov.info"
  353. # For scripts: avoid src/ext and src/trunnel.
  354. # Keep these lists consistent:
  355. # - OWNED_TOR_C_FILES in Makefile.am
  356. # - CHECK_FILES in pre-commit.git-hook and pre-push.git-hook
  357. # - try_parse in check_cocci_parse.sh
  358. OWNED_TOR_C_FILES=\
  359. $(top_srcdir)/src/lib/*/*.[ch] \
  360. $(top_srcdir)/src/core/*/*.[ch] \
  361. $(top_srcdir)/src/feature/*/*.[ch] \
  362. $(top_srcdir)/src/app/*/*.[ch] \
  363. $(top_srcdir)/src/test/*.[ch] \
  364. $(top_srcdir)/src/test/*/*.[ch] \
  365. $(top_srcdir)/src/tools/*.[ch]
  366. check-spaces:
  367. if USE_PERL
  368. $(PERL) $(top_srcdir)/scripts/maint/checkSpace.pl -C \
  369. $(OWNED_TOR_C_FILES)
  370. endif
  371. check-includes:
  372. if USEPYTHON
  373. $(PYTHON) $(top_srcdir)/scripts/maint/practracker/includes.py $(top_srcdir)
  374. endif
  375. check-best-practices:
  376. if USEPYTHON
  377. @$(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py $(top_srcdir) $(TOR_PRACTRACKER_OPTIONS)
  378. endif
  379. check-cocci:
  380. VERBOSE=1 $(top_srcdir)/scripts/coccinelle/check_cocci_parse.sh $(OWNED_TOR_C_FILES)
  381. practracker-regen:
  382. $(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py --regen $(top_srcdir)
  383. check-docs: all
  384. $(PERL) $(top_builddir)/scripts/maint/checkOptionDocs.pl
  385. check-logs:
  386. $(top_srcdir)/scripts/maint/checkLogs.pl \
  387. $(top_srcdir)/src/*/*.[ch] | sort -n
  388. .PHONY: check-typos
  389. check-typos:
  390. @if test -x "`which misspell 2>&1;true`"; then \
  391. echo "Checking for Typos ..."; \
  392. (misspell \
  393. $(top_srcdir)/src/[^e]*/*.[ch] \
  394. $(top_srcdir)/doc \
  395. $(top_srcdir)/contrib \
  396. $(top_srcdir)/scripts \
  397. $(top_srcdir)/README \
  398. $(top_srcdir)/ChangeLog \
  399. $(top_srcdir)/INSTALL \
  400. $(top_srcdir)/ReleaseNotes \
  401. $(top_srcdir)/LICENSE); \
  402. else \
  403. echo "Tor can use misspell to check for typos."; \
  404. echo "It seems that you don't have misspell installed."; \
  405. echo "You can install the latest version of misspell here: https://github.com/client9/misspell#install"; \
  406. fi
  407. .PHONY: rustfmt
  408. rustfmt:
  409. if USE_RUST
  410. @if test -x "`which cargo-fmt 2>&1;true`"; then \
  411. echo "Formatting Rust code ..."; \
  412. (cd "$(top_srcdir)/src/rust" && cargo fmt --all --); \
  413. else \
  414. echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
  415. echo "However, it seems that you don't have rustfmt installed."; \
  416. printf "You can install rustfmt by following the directions here:"; \
  417. echo " https://github.com/rust-lang-nursery/rustfmt"; \
  418. fi
  419. endif
  420. .PHONY: check-rustfmt
  421. check-rustfmt:
  422. if USE_RUST
  423. @if test -x "`which cargo-fmt 2>&1;true`"; then \
  424. printf "Running rustfmt..."; \
  425. (cd "$(top_srcdir)/src/rust" && cargo fmt --all -- --check && echo "done.") || \
  426. (echo "**************** check-rustfmt failed. ****************"; \
  427. echo " Run \`make rustfmt\` to apply the above changes."; \
  428. exit 1); \
  429. else \
  430. echo "Tor uses rustfmt (via cargo-fmt) to format Rust code."; \
  431. echo "However, it seems that you don't have rustfmt installed."; \
  432. printf "You can install rustfmt by following the directions here:"; \
  433. echo " https://github.com/rust-lang-nursery/rustfmt"; \
  434. fi
  435. endif
  436. .PHONY: clippy
  437. clippy:
  438. if USE_RUST
  439. @if test -x "`which cargo-clippy 2>&1;true`"; then \
  440. echo "Running cargo clippy ..."; \
  441. echo "Prepare yourself for the onslaught of suggestions ..."; \
  442. (cd "$(top_srcdir)/src/rust" && cargo clippy); \
  443. else \
  444. echo "Tor can use clippy to lint Rust code."; \
  445. echo "However, it seems that you don't have clippy installed."; \
  446. echo "You can install the latest version of clippy by following the directions here: https://github.com/rust-lang-nursery/rust-clippy"; \
  447. fi
  448. endif
  449. .PHONY: check-changes
  450. check-changes:
  451. if USEPYTHON
  452. @if test -d "$(top_srcdir)/changes"; then \
  453. PACKAGE_VERSION=$(PACKAGE_VERSION) $(PYTHON) $(top_srcdir)/scripts/maint/lintChanges.py $(top_srcdir)/changes; \
  454. fi
  455. endif
  456. .PHONY: update-versions
  457. update-versions:
  458. abs_top_srcdir="$(abs_top_srcdir)" $(PYTHON) $(top_srcdir)/scripts/maint/update_versions.py
  459. .PHONY: callgraph
  460. callgraph:
  461. cd $(top_builddir); $(abs_top_srcdir)/scripts/maint/run_calltool.sh
  462. version:
  463. @echo "Tor @VERSION@"
  464. @if test -d "$(top_srcdir)/.git" && test -x "`which git 2>&1;true`"; then \
  465. echo -n "git: " ;\
  466. (cd "$(top_srcdir)" && git rev-parse --short=16 HEAD); \
  467. fi
  468. .PHONY: autostyle-ifdefs
  469. autostyle-ifdefs:
  470. $(PYTHON) $(top_srcdir)/scripts/maint/annotate_ifdef_directives.py $(OWNED_TOR_C_FILES)
  471. .PHONY: autostyle-ifdefs
  472. autostyle-operators:
  473. $(PERL) $(top_srcdir)/scripts/coccinelle/test-operator-cleanup $(OWNED_TOR_C_FILES)
  474. .PHONY: rectify-includes
  475. rectify-includes:
  476. cd $(top_srcdir); $(PYTHON) $(abs_top_srcdir)/scripts/maint/rectify_include_paths.py
  477. .PHONY: update-copyright
  478. update-copyright:
  479. $(PERL) $(top_srcdir)/scripts/maint/updateCopyright.pl $(OWNED_TOR_C_FILES)
  480. .PHONY: autostyle
  481. autostyle: update-versions rustfmt autostyle-ifdefs rectify-includes
  482. mostlyclean-local:
  483. rm -f $(top_builddir)/src/*/*.gc{da,no} $(top_builddir)/src/*/*/*.gc{da,no}
  484. rm -rf $(HTML_COVER_DIR)
  485. rm -rf $(top_builddir)/doc/doxygen
  486. rm -rf $(TEST_NETWORK_ALL_LOG_DIR)
  487. clean-local:
  488. rm -rf $(top_builddir)/src/rust/target
  489. rm -rf $(top_builddir)/src/rust/.cargo/registry
  490. if USE_RUST
  491. distclean-local: distclean-rust
  492. endif
  493. # This relies on some internal details of how automake implements
  494. # distcheck. We check two directories because automake-1.15 changed
  495. # from $(distdir)/_build to $(distdir)/_build/sub.
  496. show-distdir-testlog:
  497. @if test -d "$(distdir)/_build/sub"; then \
  498. cat $(distdir)/_build/sub/$(TEST_SUITE_LOG); \
  499. else \
  500. cat $(distdir)/_build/$(TEST_SUITE_LOG); fi
  501. # Similarly, this relies on automake internals to run file on an
  502. # intermittent core file whose provenance is not known to us. See
  503. # ticket 26787.
  504. show-distdir-core:
  505. @if test -d "$(distdir)/_build/sub"; then \
  506. file $(distdir)/_build/sub/core ; \
  507. else \
  508. file $(distdir)/_build/core; fi
  509. show-libs:
  510. @echo $(TOR_INTERNAL_LIBS)
  511. show-testing-libs:
  512. @echo $(TOR_INTERNAL_TESTING_LIBS)
  513. # Note here that we hardcode this -j2 because if the user would pass too many
  514. # cores, bear actually chockes and dies :S. For this to work, a make clean
  515. # needs to be done else bear will miss some compile flags.
  516. lsp:
  517. @if test -x "`which bear 2>&1;true`"; then \
  518. echo "Generating LSP compile_commands.json. Might take few minutes..."; \
  519. $(MAKE) clean 2>&1 >/dev/null; \
  520. bear >/dev/null 2>&1 -- $(MAKE) -j2 2>&1 >/dev/null; \
  521. echo "Generating .ccls file..."; \
  522. ./scripts/maint/gen_ccls_file.sh \
  523. else \
  524. echo "No bear command found. On debian, apt install bear"; \
  525. fi