Commit f40dc287 authored by Karsten Loesing's avatar Karsten Loesing
Browse files

Clean up the doc/HACKING/* docs a bit.

parent 19e10f95

doc/HACKING/CodingStandards.txt

+1 −1
Original line number Diff line number Diff line
@@ -122,7 +122,7 @@ using gcc, you should invoke the configure script with the option 
"--enable-gcc-warnings".  This will give a bunch of extra warning flags to

the compiler, and help us find divergences from our preferred C style.



Functions to use; functions not to use.

Functions to use; functions not to use

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



We have some wrapper functions like tor_malloc, tor_free, tor_strdup, and

doc/HACKING/GettingStarted.txt

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ file that comes with the Tor source for more information on building it, 
and any high-quality guide to C for information on programming.)



I'm also going to assume that you know a little bit about how to use

Git, or that you're able to fillow one of the several excellent guides

Git, or that you're able to follow one of the several excellent guides

at http://git-scm.org to learn.



Most Tor developers develop using some Unix-based system, such as Linux,

doc/HACKING/HelpfulTools.txt

+4 −4
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ The preprocessor define __clang_analyzer__ is used to work around instances 
where clang picks up behavior that we wish to permit.



clang Runtime Sanitizers

~~~~~~~~~~~~~~~~

~~~~~~~~~~~~~~~~~~~~~~~~



To build the Tor codebase with the clang Address and Undefined Behavior

sanitizers, see the file contrib/clang/sanitize_blacklist.txt.
@@ -100,7 +100,7 @@ To run all tests, including those based on Stem or Chutney: 
   make test-full

-----



To run all tests, including those basedd on Stem or Chutney that require a

To run all tests, including those based on Stem or Chutney that require a

working connection to the internet:

-----

   make test-full-online
@@ -247,7 +247,7 @@ to clutter the files with emacs stuff. 




Doxygen

~~~~~~~~

~~~~~~~



We use the 'doxygen' utility to generate documentation from our

source code. Here's how to use it:
@@ -256,7 +256,7 @@ source code. Here's how to use it: 
         /**

          * \file filename.c

          * \brief Short description of the file.

          **/

          */



     (Doxygen will recognize any comment beginning with /** as special.)

doc/HACKING/HowToReview.txt

+1 −1
Original line number Diff line number Diff line
@@ -25,7 +25,7 @@ memory? 
Do all the new functions, global variables, types, and structure members have

documentation?



Do all the the functions, global variables, types, and structure members with

Do all the functions, global variables, types, and structure members with

modified behavior have modified documentation?



Do all the new torrc options have documentation?

doc/HACKING/ReleasingTor.txt

+2 −2
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ git branches too. 
   scripts/maint/updateVersions.pl to update version numbers in other

   places, and commit.  Then merge maint-0.2.x into release-0.2.x.



   (NOTE: TO bump the version number, edit configure.ac, and then run

   (NOTE: To bump the version number, edit configure.ac, and then run

   either make, or 'perl scripts/maint/updateVersions.pl', depending on

   your version.)
@@ -78,7 +78,7 @@ git branches too. 
a while to see if anybody has problems building it. Try to get Sebastian

or somebody to try building it on Windows.



6) Get at least two of weasel/arma/sebastian to put the new version number

6) Get at least two of weasel/arma/Sebastian to put the new version number

in their approved versions list.



7) Sign the tarball, then sign and push the git tag: