1. The scripts directory holds tools for use in building, generating, testing,
  2. and maintaining the Tor source code. It is mainly for use by developers.
  3. Code maintenance scripts
  4. ------------------------
  5. maint/ -- Verify that Tor log statements are unique.
  6. maint/ -- Look for autoconf tests whose results are
  7. never used.
  8. maint/ -- Make sure that Tor options are documented in the
  9. manpage, and that the manpage only documents real Tor options.
  10. maint/ -- Style checker for the Tor source code. Mainly checks
  11. whitespace.
  12. maint/ -- Find a set of changes/* files that have been
  13. merged into an upstream version.
  14. maint/ -- Flow the changelog into the proper format.
  15. maint/ -- Find places that should have DOCDOC comments to indicate a
  16. need for doxygen comments, and put those comments there.
  17. maint/ -- Update the version number in the .nsi and windows
  18. orconfig.h files.
  19. Testing scripts
  20. ---------------
  21. test/ -- a git bisect run script that bisects using
  22. chutney. The script builds tor and tor-gencert, then runs chutney. The script
  23. takes optional arguments for out-of-tree builds, and specific chutney network
  24. flavours. You should copy this script before using it with git bisect, so that
  25. it doesn't change (or disappear) during bisection.
  26. test/cov-blame -- Mash up the results of gcov with git blame. Mainly useful
  27. to find out who has been writing untested code.
  28. test/cov-diff -- Compare two directories of gcov files to identify changed
  29. lines without coverage.
  30. test/coverage -- Generates a directory full of gcov files. You need to use
  31. this script instead of calling gcov directly because of our confusingly named
  32. object files.
  33. test/ -- Example script for invoking clang's scan-build
  34. static analysis tools.
  35. Code generation scripts
  36. -----------------------
  37. codegen/ -- Generate a table mapping linux syscall
  38. numbers to their names.
  39. codegen/ -- Generate a sorted list of TLS ciphersuites
  40. for servers to choose from.
  41. codegen/ -- Generate a list of TLS ciphersuites for
  42. clients to use in order to look like Firefox.
  43. Code transformation scripts
  44. ---------------------------
  45. coccinelle/calloc.cocci -- Transform code to replace variants of
  46. malloc(a*b) with calloc(a,b)