Makefile.am

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