Deepesh Pathak ca6682f3f8 Fix spelling mistakes corresponding to ticket #23650 6 years ago
coccinelle 9e1fa95920 Add Coccinelle patch for replacing NULL/non-NULL tt_assert(). 7 years ago
codegen b601eeda0e all the other lines here had a tab; make this one blend in 6 years ago
maint ca6682f3f8 Fix spelling mistakes corresponding to ticket #23650 6 years ago
test 455cc12b51 Update to work with the latest clangalyzer 6 years ago
README be231b0db1 Add scripts/coccinelle to scripts/README 10 years ago


The scripts directory holds tools for use in building, generating, testing,
and maintaining the Tor source code. It is mainly for use by developers.

Code maintenance scripts

maint/ -- Verify that Tor log statements are unique.

maint/ -- Look for autoconf tests whose results are
never used.

maint/ -- Make sure that Tor options are documented in the
manpage, and that the manpage only documents real Tor options.

maint/ -- Style checker for the Tor source code. Mainly checks

maint/ -- Find a set of changes/* files that have been
merged into an upstream version.

maint/ -- Flow the changelog into the proper format.

maint/ -- Find places that should have DOCDOC comments to indicate a
need for doxygen comments, and put those comments there.

maint/ -- Update the version number in the .nsi and windows
orconfig.h files.

Testing scripts

test/cov-blame -- Mash up the results of gcov with git blame. Mainly useful
to find out who has been writing untested code.

test/cov-diff -- Compare two directories of gcov files to identify changed
lines without coverage.

test/coverage -- Generates a directory full of gcov files. You need to use
this script instead of calling gcov directly because of our confusingly named
object files.

test/ -- Example script for invoking clang's scan-build
static analysis tools.

Code generation scripts

codegen/ -- Generate a table mapping linux syscall
numbers to their names.

codegen/ -- Generate a sorted list of TLS ciphersuites
for servers to choose from.

codegen/ -- Generate a list of TLS ciphersuites for
clients to use in order to look like Firefox.

Code transformation scripts

coccinelle/calloc.cocci -- Transform code to replace variants of
malloc(a*b) with calloc(a,b)