Selaa lähdekoodia

doc(hacking): update = to # on sections

Antoine Veuiller 4 vuotta sitten
vanhempi
commit
3bf90e704c
3 muutettua tiedostoa jossa 15 lisäystä ja 15 poistoa
  1. 2 2
      doc/HACKING/EndOfLifeTor.md
  2. 7 7
      doc/HACKING/Fuzzing.md
  3. 6 6
      doc/HACKING/ReleasingTor.md

+ 2 - 2
doc/HACKING/EndOfLifeTor.md

@@ -7,7 +7,7 @@ series reaches End of Life.  Note that they are _only_ for entire series that
 have reached their planned EOL: they do not apply to security-related
 have reached their planned EOL: they do not apply to security-related
 deprecations of individual versions.
 deprecations of individual versions.
 
 
-=== 0. Preliminaries
+### 0. Preliminaries
 
 
 0. A few months before End of Life:
 0. A few months before End of Life:
    Write a deprecation announcement.
    Write a deprecation announcement.
@@ -17,7 +17,7 @@ deprecations of individual versions.
    Send the announcement to tor-announce, tor-talk, tor-relays, and the
    Send the announcement to tor-announce, tor-talk, tor-relays, and the
    packagers.
    packagers.
 
 
-=== 1. On the day
+### 1. On the day
 
 
 1. Open tickets to remove the release from:
 1. Open tickets to remove the release from:
    - the jenkins builds
    - the jenkins builds

+ 7 - 7
doc/HACKING/Fuzzing.md

@@ -1,6 +1,6 @@
-= Fuzzing Tor
+# Fuzzing Tor
 
 
-== The simple version (no fuzzing, only tests)
+## The simple version (no fuzzing, only tests)
 
 
 Check out fuzzing-corpora, and set TOR_FUZZ_CORPORA to point to the place
 Check out fuzzing-corpora, and set TOR_FUZZ_CORPORA to point to the place
 where you checked it out.
 where you checked it out.
@@ -12,7 +12,7 @@ This won't actually fuzz Tor!  It will just run all the fuzz binaries
 on our existing set of testcases for the fuzzer.
 on our existing set of testcases for the fuzzer.
 
 
 
 
-== Different kinds of fuzzing
+## Different kinds of fuzzing
 
 
 Right now we support three different kinds of fuzzer.
 Right now we support three different kinds of fuzzer.
 
 
@@ -37,7 +37,7 @@ In all cases, you'll need some starting examples to give the fuzzer when it
 starts out.  There's a set in the "fuzzing-corpora" git repository.  Try
 starts out.  There's a set in the "fuzzing-corpora" git repository.  Try
 setting TOR_FUZZ_CORPORA to point to a checkout of that repository
 setting TOR_FUZZ_CORPORA to point to a checkout of that repository
 
 
-== Writing Tor fuzzers
+## Writing Tor fuzzers
 
 
 A tor fuzzing harness should have:
 A tor fuzzing harness should have:
 * a fuzz_init() function to set up any necessary global state.
 * a fuzz_init() function to set up any necessary global state.
@@ -52,7 +52,7 @@ bug, or accesses memory it shouldn't. This helps fuzzing frameworks detect
 "interesting" cases.
 "interesting" cases.
 
 
 
 
-== Guided Fuzzing with AFL
+## Guided Fuzzing with AFL
 
 
 There is no HTTPS, hash, or signature for American Fuzzy Lop's source code, so
 There is no HTTPS, hash, or signature for American Fuzzy Lop's source code, so
 its integrity can't be verified. That said, you really shouldn't fuzz on a
 its integrity can't be verified. That said, you really shouldn't fuzz on a
@@ -101,7 +101,7 @@ macOS (OS X) requires slightly more preparation, including:
 * using afl-clang (or afl-clang-fast from the llvm directory)
 * using afl-clang (or afl-clang-fast from the llvm directory)
 * disabling external crash reporting (AFL will guide you through this step)
 * disabling external crash reporting (AFL will guide you through this step)
 
 
-== Triaging Issues
+## Triaging Issues
 
 
 Crashes are usually interesting, particularly if using AFL_HARDEN=1 and --enable-expensive-hardening. Sometimes crashes are due to bugs in the harness code.
 Crashes are usually interesting, particularly if using AFL_HARDEN=1 and --enable-expensive-hardening. Sometimes crashes are due to bugs in the harness code.
 
 
@@ -115,7 +115,7 @@ To see what fuzz-http is doing with a test case, call it like this:
 
 
 (Logging is disabled while fuzzing to increase fuzzing speed.)
 (Logging is disabled while fuzzing to increase fuzzing speed.)
 
 
-== Reporting Issues
+## Reporting Issues
 
 
 Please report any issues discovered using the process in Tor's security issue
 Please report any issues discovered using the process in Tor's security issue
 policy:
 policy:

+ 6 - 6
doc/HACKING/ReleasingTor.md

@@ -5,7 +5,7 @@ Putting out a new release
 Here are the steps that the maintainer should take when putting out a
 Here are the steps that the maintainer should take when putting out a
 new Tor release:
 new Tor release:
 
 
-=== 0. Preliminaries
+### 0. Preliminaries
 
 
 1. Get at least two of weasel/arma/Sebastian to put the new
 1. Get at least two of weasel/arma/Sebastian to put the new
    version number in their approved versions list.  Give them a few
    version number in their approved versions list.  Give them a few
@@ -18,7 +18,7 @@ new Tor release:
    date of a TB that contains it.  See note below in "commit, upload,
    date of a TB that contains it.  See note below in "commit, upload,
    announce".
    announce".
 
 
-=== I. Make sure it works
+### I. Make sure it works
 
 
 1. Make sure that CI passes: have a look at Travis
 1. Make sure that CI passes: have a look at Travis
    (https://travis-ci.org/torproject/tor/branches), Appveyor
    (https://travis-ci.org/torproject/tor/branches), Appveyor
@@ -52,7 +52,7 @@ new Tor release:
       memory leaks.)
       memory leaks.)
 
 
 
 
-=== II. Write a changelog
+### II. Write a changelog
 
 
 
 
 1a. (Alpha release variant)
 1a. (Alpha release variant)
@@ -139,7 +139,7 @@ new Tor release:
    text of existing entries, though.)
    text of existing entries, though.)
 
 
 
 
-=== III. Making the source release.
+### III. Making the source release.
 
 
 1. In `maint-0.?.x`, bump the version number in `configure.ac` and run
 1. In `maint-0.?.x`, bump the version number in `configure.ac` and run
    `make update-versions` to update version numbers in other
    `make update-versions` to update version numbers in other
@@ -165,7 +165,7 @@ new Tor release:
    If it is not, you'll need to poke Roger, Weasel, and Sebastian again: see
    If it is not, you'll need to poke Roger, Weasel, and Sebastian again: see
    item 0.1 at the start of this document.
    item 0.1 at the start of this document.
 
 
-=== IV. Commit, upload, announce
+### IV. Commit, upload, announce
 
 
 1. Sign the tarball, then sign and push the git tag:
 1. Sign the tarball, then sign and push the git tag:
 
 
@@ -241,7 +241,7 @@ new Tor release:
    For templates to use when announcing, see:
    For templates to use when announcing, see:
        https://trac.torproject.org/projects/tor/wiki/org/teams/NetworkTeam/AnnouncementTemplates
        https://trac.torproject.org/projects/tor/wiki/org/teams/NetworkTeam/AnnouncementTemplates
 
 
-=== V. Aftermath and cleanup
+### V. Aftermath and cleanup
 
 
 1. If it's a stable release, bump the version number in the
 1. If it's a stable release, bump the version number in the
     `maint-x.y.z` branch to "newversion-dev", and do a `merge -s ours`
     `maint-x.y.z` branch to "newversion-dev", and do a `merge -s ours`