Commit Graph

33980 Commits

Author SHA1 Message Date
Nick Mathewson
a33d1dce8a directory-level documentation for feature/* 2019-11-04 17:07:38 -05:00
Nick Mathewson
e1cdca2e4f directory-level doxygen for "src/core" 2019-11-04 16:28:28 -05:00
Nick Mathewson
607b1ff776 Move much of 00-overview.md into doxygen. 2019-11-04 12:24:46 -05:00
Nick Mathewson
a5085c52d0 Move most of crypto overview into doxygen. 2019-11-04 12:10:28 -05:00
Nick Mathewson
211a2e0a8f Move doc/HACKING/design/01b-collections.md into doxygen. 2019-11-04 12:07:38 -05:00
Nick Mathewson
fb20618e28 Divide 01a-memory.md into doxygen. 2019-11-04 12:04:32 -05:00
Nick Mathewson
4bf73dfa26 Remove now-superseded part of doc/HACKING/design. 2019-11-04 11:52:49 -05:00
Nick Mathewson
76e8effc7b Doxygen: document the rest of the directories in lib.
(This copies documentation from doc/HACKING/design, and edits for
concisensess and clarity.)
2019-11-04 11:51:38 -05:00
Nick Mathewson
fd27136329 Doxygen: fix a remaining \ref-to-directory
This one was missed by the perl script in the last commit because
it spanned a newline.
2019-11-04 11:13:30 -05:00
Nick Mathewson
9b13191192 Doxygen: use \refdir everywhere.
This commit was generated with:

find src -name '*.dox' |xargs perl -i -pe 's{\\ref src/(\S+) \"\S+}{\\refdir{$1}};'
2019-11-04 11:12:27 -05:00
Nick Mathewson
b95bc4d839 Doxygen: define an alias for linking to a directory.
We need to use this kind of trickery to make directory links work in
out-of-tree builds.
2019-11-04 11:08:04 -05:00
Nick Mathewson
62a473debf Doxygen: Avoid ambiguity in @dir directives
This commit was automatically generated with:

find src -name '*.dox' |xargs perl -i -pe 's{\@dir ([^/])}{\@dir /$1};'
2019-11-04 10:23:36 -05:00
Nick Mathewson
51a9892914 doxygen: Take "lib" descriptions from doc/HACKING/design.
This commit takes descriptions for src/lib and moves them into our
doxygen hierarchy.  I've covered everything from lib/cc through
lib/sandbox here.
2019-11-04 10:21:10 -05:00
Nick Mathewson
b6b1257099 Remove spurious lib/stats doxygen file. 2019-11-04 10:19:23 -05:00
Nick Mathewson
d3af23783c Document our top-level directories 2019-11-04 07:40:20 -05:00
Nick Mathewson
7fc077ed25 Add stub directory-level documentation for most source directories
This includes app, core, feature, lib, and tools, but excludes
ext, test, and trunnel.

This was generated by the following shell script:

cd src
for dname in $(find lib core feature app tools -type d |grep -v \\.deps$); do
    keyword="$(echo "$dname" |sed -e "s/\//_/" )"
    target="${dname}/${keyword}.dox"
    echo "$target"
    cat <<EOF >"$target"
/**
@dir ${dname}
@brief ${dname}
**/
EOF

    git add "$target"
done
2019-11-04 07:40:14 -05:00
Nick Mathewson
afc267e887 Add a stub main page for the documentation. 2019-11-03 15:04:35 -05:00
Nick Mathewson
e2da29e045 Doxygen: Better path handling.
This change tells doxygen to include all files not explicitly
excluded, and to document paths along with filenames.
2019-11-03 15:00:14 -05:00
Nick Mathewson
7ec314a67f Doxygen: accept .dox as pure doxygen, and interpret everything as C 2019-11-03 12:16:36 -05:00
Nick Mathewson
096cbfb8b0 Merge remote-tracking branch 'tor-github/pr/1480' 2019-11-01 09:35:17 -04:00
Nick Mathewson
7824a65aa0 Doxyfile.in: switch to a tor-style green color scheme. 2019-11-01 09:23:10 -04:00
George Kadianakis
fa0257eda0 Merge branch 'tor-github/pr/1484' 2019-10-31 15:31:14 +08:00
teor
e046903f93
scripts/git: Restore a dropped check for pre-commit in pre-push
Bugfix on 31919; not in any released version of Tor.
2019-10-31 14:51:31 +10:00
teor
7e73c0d5a1
scripts/git: Print the correct path in git-setup-dirs.sh 2019-10-31 14:39:49 +10:00
teor
cb7340abf1
scripts/git: Don't use spaces in git URLs 2019-10-31 13:56:59 +10:00
teor
40e75bc3e1
doc: Add defaults for some transport options 2019-10-31 11:27:26 +10:00
teor
a18e84ad01
config: Improve some function comments 2019-10-31 11:11:51 +10:00
teor
4666ca73a1
config: Give warn_about_relative_paths() const args
Also gives make_path_absolute() const args.

Obviously correct fixes to already reviewed code.
2019-10-31 10:53:26 +10:00
Nick Mathewson
a6ad26fd5f Merge remote-tracking branch 'tor-github/pr/1485' 2019-10-30 16:16:12 -04:00
David Goulet
cfc60e566c circ: Add an handle to circuit_t
Closes #32343

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-10-30 16:12:56 -04:00
Nick Mathewson
5a1dfca071 Fix 32167: comment in config.c 2019-10-30 16:05:48 -04:00
teor
183f9e490f
test: Fix a comment typo in src/test/test_hs_ntor.sh 2019-10-31 00:43:13 +10:00
teor
861b9366df
test: Fix a loop variable bug in test_parseconf.sh
Obviously correct fixes to already reviewed code.
No changes file required: not in any released version of tor.
2019-10-31 00:23:30 +10:00
David Goulet
f579541f13 Merge branch 'tor-github/pr/1468' 2019-10-30 08:53:51 -04:00
Neel Chauhan
f81e4aa831 hs-v2: Lookup intro failure cache when picking an intro from descriptor
When picking an intro point from the service descriptor, the client failed to
lookup the failure cache.

It made an HS v2 client re-pick bad intro points for which we already know it
won't work in the first place.

Based on Neel Chauhan original patch.

Fixes #25568

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-10-30 08:47:21 -04:00
teor
dce1f63d44
fs: Clarify an ambiguous comment about string/pointer equality 2019-10-30 16:15:43 +10:00
Taylor Yu
1e8ddbe1ee Changes file for ticket 32277 2019-10-29 16:39:03 -05:00
Taylor Yu
5e4ae73051 Reformat some options in tor.1.txt
Reformat command line options in tor.1.txt to display as fixed-width
in the HTML version.  Based on a patch by Swati Thacker.  Part of
ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
8660a32d18 Reword command-options in tor.1.txt
Reword the COMMAND-LINE OPTIONS section of tor.1.txt.  Based on a
patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
90ba8bae3f Reword DESCRIPTION in tor.1.txt
Reword the DESCRIPTION section of tor.1.txt.

Based on a patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
Taylor Yu
4c38fccb9b Move command-line conf option description earlier
In tor.1.txt, move the paragraphs at the end of the COMMAND-LINE
OPTIONS section earlier.  This text describes how the user can specify
configuration options on the command line.

Also clarify some wording and formatting.

Based on a patch by Swati Thacker.  Part of ticket 32277.
2019-10-29 16:39:03 -05:00
George Kadianakis
4413b98190 Merge branch 'tor-github/pr/1456' 2019-10-29 21:29:13 +08:00
teor
30705e8294
app/config: Fix a comment typo in config.c
The options validation is now a callback.

Bugfix on 31241; not in any released version of tor.
2019-10-29 12:40:20 +10:00
teor
b448f6044d
Merge branch 'maint-0.4.2' 2019-10-29 08:27:02 +10:00
teor
2395800d3e
Merge branch 'maint-0.4.1' into maint-0.4.2 2019-10-29 08:26:55 +10:00
teor
63aff4a43e
Merge branch 'maint-0.4.0' into maint-0.4.1 2019-10-29 08:26:48 +10:00
teor
54e2d0dc2d
Merge branch 'maint-0.3.5' into maint-0.4.0 2019-10-29 08:26:40 +10:00
teor
15d67842f9
Merge branch 'maint-0.2.9' into maint-0.3.5 2019-10-29 08:26:32 +10:00
teor
752c35ca96
Merge remote-tracking branch 'tor-github/pr/1460' into maint-0.2.9 2019-10-29 08:23:35 +10:00
David Goulet
d67db64ced changes: Add file for ticket 32196
Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-10-28 13:21:08 -04:00