src/trunnel/README

   1 This directory contains code for use with, and code made by, the
   2 automatic code generation tool "Trunnel".
   3
   4 Trunnel generates binary parsers and formatters for simple data
   5 structures. It aims for human-readable, obviously-correct outputs over
   6 maximum efficiency or flexibility.
   7
   8 The .trunnel files are the inputs here; the .c and .h files are the outputs.
   9
  10 To add a new structure:
  11    - Add a new .trunnel file or expand an existing one to describe the format
  12      of the structure.
  13    - Regenerate the .c and .h files.  To do this, you run
  14      "scripts/codegen/run_trunnel.sh".  You'll need trunnel installed.
  15    - Add the .trunnel, .c, and .h files to include.am
  16
  17 For the Trunnel source code, and more documentation about using Trunnel,
  18 see https://gitweb.torproject.org/trunnel.git , especially
  19     https://gitweb.torproject.org/trunnel.git/tree/README
  20 and https://gitweb.torproject.org/trunnel.git/tree/doc/trunnel.md
  21