Nick Mathewson 192b312c97 Fix coverage script. 5 years ago
coccinelle 9e1fa95920 Add Coccinelle patch for replacing NULL/non-NULL tt_assert(). 7 years ago
codegen efe55b8898 Bump copyright date to 2019. 5 years ago
maint efe55b8898 Bump copyright date to 2019. 5 years ago
test 192b312c97 Fix coverage script. 5 years ago
README 4217dc0558 Add scripts/test/, for bisecting using chutney 5 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/ -- a git bisect run script that bisects using
chutney. The script builds tor and tor-gencert, then runs chutney. The script
takes optional arguments for out-of-tree builds, and specific chutney network
flavours. You should copy this script before using it with git bisect, so that
it doesn't change (or disappear) during bisection.

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)