README 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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/checkLogs.pl -- Verify that Tor log statements are unique.
  6. maint/checkOptionDocs.pl -- Make sure that Tor options are documented in the
  7. manpage, and that the manpage only documents real Tor options.
  8. maint/checkSpaces.pl -- Style checker for the Tor source code. Mainly checks
  9. whitespace.
  10. maint/findMergedChanges.pl -- Find a set of changes/* files that have been
  11. merged into an upstream version.
  12. maint/format_changelog.py -- Flow the changelog into the proper format.
  13. maint/redox.py -- Find places that should have DOCDOC comments to indicate a
  14. need for doxygen comments, and put those comments there.
  15. maint/updateVersions.pl -- Update the version number in the .nsi and windows
  16. orconfig.h files.
  17. Testing scripts
  18. ---------------
  19. test/cov-blame -- Mash up the results of gcov with git blame. Mainly useful
  20. to find out who has been writing untested code.
  21. test/cov-diff -- Compare two directories of gcov files to identify changed
  22. lines without coverage.
  23. test/coverage -- Generates a directory full of gcov files. You need to use
  24. this script instead of calling gcov directly because of our confusingly named
  25. object files.
  26. test/scan-build.sh -- Example script for invoking clang's scan-build
  27. static analysis tools.
  28. Code generation scripts
  29. -----------------------
  30. codegen/gen_linux_syscalls.pl -- Generate a table mapping linux syscall
  31. numbers to their names.
  32. codegen/gen_server_ciphers.py -- Generate a sorted list of TLS ciphersuites
  33. for servers to choose from.
  34. codegen/get_mozilla_ciphers.py -- Generate a list of TLS ciphersuites for
  35. clients to use in order to look like Firefox.