Commit Graph

34258 Commits

Author SHA1 Message Date
Nick Mathewson
36bceacdcd Doxygen: set TYPEDEF_HIDES_STRUCT.
This option tells doxygen to handle typedef struct foo_t foo_t by
making foo_t and struct foo_t synonymous. This lets doxygen find
documentation that it would otherwise miss: otherwise, if it sees
documentation for "int func(foo_t *)" and a prototype for
"int func(struct foo_t)", it will think that the prototype is
undocumented.

Part of #32386.
2019-11-05 12:43:21 -05:00
Nick Mathewson
d3e547b2bd Re-think our doxygen warnings wrt missing docs and fatalness.
Up till now, we have warned about all missing documentation, which
meant that we could never make doxygen warnings fatal.  This has led
to our doxygen output getting full of errors several times in the
past.

This commit changes our approach to doxygen warnings: missing
documentation warnings are only on when the user asks for them with
--enable-missing-doc-warnings.  When that option is not present,
doxygen respects the --enable-fatal-warnings flag.

Closes ticket 32385.
2019-11-05 12:24:02 -05:00
David Goulet
884056ae57 Merge branch 'tor-github/pr/1498' 2019-11-05 09:05:26 -05:00
Nick Mathewson
6c4479a90e Remove a dot from ALIASES declaration. 2019-11-05 09:02:59 -05:00
Nick Mathewson
c01f624f4a Another attempt to fix Doxygen references in out-of-tree builds
This time, we're using cd to run doxygen from inside the source
directory, not the build directory at all.  This lets us call the
source directory ".", which (I hope) both Doxygen 1.8.13 and 1.8.15
will understand.

Naturally, this requires a corresponding change in the doxygen
configuration so that we are directing the output to the correct
place.

Fix for 32378.
2019-11-05 08:57:39 -05:00
Nick Mathewson
fa860b6b17 Revert "doxygen: Use @SRCDIR@ instead of @top_srcdir@."
This reverts commit 4c2c98900b.
2019-11-05 08:49:48 -05:00
Nick Mathewson
4c2c98900b doxygen: Use @SRCDIR@ instead of @top_srcdir@.
Our @top_srcdir@ directory can contain "..", which confuses doxygen
when it tries to make references to directories.  Using
@abs_top_srcdir@ has the same problem.  Instead, we should use our
@SRCDIR@ configuration variable, which is canonicalized.
2019-11-05 08:37:22 -05:00
David Goulet
326f82db04 hs-v2: Fix memory leak in error code path
Coverity CID: 1455168

Closes #32356

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-11-05 08:24:46 -05:00
Nick Mathewson
6e023d5585 Merge remote-tracking branch 'tor-github/pr/1497' 2019-11-05 08:08:38 -05:00
Nick Mathewson
8933789fef Merge branch 'doxygen_libs' 2019-11-05 08:05:49 -05:00
Nick Mathewson
aac80a004f Doxygen: add several missing links. 2019-11-05 08:05:42 -05:00
David Goulet
cd7812b470 test: Handle NULL circuit pointer in new_fake_orcirc
Coverity CID: 1455207

Closes #32376

Signed-off-by: David Goulet <dgoulet@torproject.org>
2019-11-05 08:05:22 -05:00
teor
804d7c9bfc
configure: Remove a check that will always fail
And update the changes file to be more specific.

Part of 32191.
2019-11-05 15:48:01 +10:00
Hans-Christoph Steiner
2a349006b9
force pkg-config to only use --prefix when cross-compiling
The current pkg-config setup has no sense of whether it is cross-compiling,
so it will detect things on the build system that are not present or are
wrong for the host system.  This forces the cross-compiling build to only
look for pkg-config .pc files in --prefix.

A version of this has been the setup for many years with the Android builds.

Fixes #32191

Signed-off-by: Hans-Christoph Steiner <hans@eds.org>
2019-11-05 15:45:25 +10:00
teor
60d5ff303d
practracker: Preserve improvements 2019-11-05 14:28:02 +10:00
teor
655603c779
Merge remote-tracking branch 'tor-github/pr/1487'
Combine V_IMMUTABLE and FILENAME changes on PidFile.
2019-11-05 14:26:23 +10:00
teor
b9269d6d0a
Merge remote-tracking branch 'tor-github/pr/1486' 2019-11-05 14:23:56 +10:00
teor
6169469546
Merge remote-tracking branch 'tor-github/pr/1477' 2019-11-05 14:23:10 +10:00
teor
bcb38d984d practracker: Update the exceptions file with improvements
Regenerate the exceptions file, but only commit the improvements.

Includes changes from 32213 and other tickets.
2019-11-05 12:50:08 +10:00
teor
8b91fa7075 config: Run "make autostyle"
Part of 32213.
2019-11-05 12:01:29 +10:00
teor
81972353cb scripts: Fix update_versions.py for out-of-tree builds
Fixes bug 32371; bugfix on 0.4.0.1-alpha.
2019-11-05 12:00:59 +10:00
teor
9e2a2d38f4 Makefile: Fix "make autostyle" for out-of-tree builds
Fixes bug 32370; bugfix on 0.4.1.2-alpha.
2019-11-05 12:00:57 +10:00
teor
c065ad3e3d practracker: Rename functions modified by a previous commit
Part of 32213.
2019-11-05 11:36:26 +10:00
teor
f10aa77afe config: Wrap a long line in relay_config.c
Part of 32213.
2019-11-05 11:36:19 +10:00
teor
cb8ebc0b4c config: Rename new global functions with a prefix
This is an automated commit, generated by this command:

./scripts/maint/rename_c_identifier.py \
        get_dirportfrontpage relay_get_dirportfrontpage \
        parse_port_config port_parse_config \
        count_real_listeners port_count_real_listeners \
        parse_transport_line pt_parse_transport_line \
        ensure_bandwidth_cap config_ensure_bandwidth_cap \
        get_effective_bwrate relay_get_effective_bwrate \
        get_effective_bwburst relay_get_effective_bwburst \
        warn_nonlocal_ext_orports port_warn_nonlocal_ext_orports \
        parse_ports_relay port_parse_ports_relay \
        update_port_set_relay port_update_port_set_relay \
        get_transport_bindaddr_from_config pt_get_bindaddr_from_config \
        get_options_for_server_transport pt_get_options_for_server_transport

It was generated with --no-verify, because it has some long lines.

Part of 32213.
2019-11-05 11:28:57 +10:00
teor
96334d6f7f changes: file for 32213 2019-11-05 11:26:26 +10:00
teor
7504711510 test/parseconf: Add conf_examples for relays
Tests relay/relay_config.c.

Part of 32213.
2019-11-05 11:12:59 +10:00
teor
6d52b5ce91 test/parseconf: Add conf_examples for PTs
Tests relay/transport_config.c.

Part of 32213.
2019-11-05 11:12:59 +10:00
teor
233b96d83a test/parseconf: Always show the result file name on failure
Obviously correct fixes on already reviewed code.
2019-11-05 11:12:50 +10:00
teor
3763dd9987 test/parseconf: Run all the tests, even if one fails
Obviously correct fixes on already reviewed code.
2019-11-05 11:08:36 +10:00
teor
1dd6717db5 test/parseconf: Consistenly use FAIL
Obviously correct fixes on already reviewed code.
2019-11-05 11:08:36 +10:00
teor
03618e0d68 test/parseconf: Don't specify a path for 'true'
Obviously correct fixes on already reviewed code.
2019-11-05 11:08:36 +10:00
teor
98637a4782 test/parseconf: Send all errors to stderr
Obviously correct fixes on already reviewed code.
2019-11-05 11:08:36 +10:00
teor
5b04db59f6 test/scripts: Use the same code to find the tor binary
This change makes sure we are always using the coverage binary, when
coverage is enabled.

Fixes bug 32368; bugfix on 0.2.7.3-rc.
2019-11-05 11:07:31 +10:00
teor
f29de4b8d2 confmgt: Stop adding a space, when there is no option value
Fixes bug 32352; bugfix on 0.0.9pre6.
2019-11-05 11:01:28 +10:00
teor
5d85c247e8 test/stats: Add minimal tests for rephist mtbf
Part of 32213.
2019-11-05 10:50:39 +10:00
teor
5d0848ebde test: Split stats into its own file
Part of 32213.
2019-11-05 10:50:39 +10:00
teor
73c0439d48 relay: Refactor tests, and add extra options tests
Part of 32213.
2019-11-05 10:49:56 +10:00
Nick Mathewson
db40202810 Document directories in "app" 2019-11-04 17:23:50 -05:00
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