4f02812242
It's 2020. Update the copyright dates with "make update-copyright"
2020-01-08 18:39:17 -05:00
8b91680d5c
Doxygen: rename all .dox files to end with .md
...
Using a standard ending here will let other tools that expect
markdown understand our output here.
This commit was automatically generated with:
for fn in $(find src -name '*.dox'); do \
git mv "$fn" "${fn%.dox}.md"; \
done
2019-11-15 09:28:12 -05:00
3a7369d0cf
Doxygen: remove /** and **/ from all .dox files
...
This is an automatically generated commit, made with:
find src -name '*.dox' | \
xargs perl -i -ne 'print unless (m#^\s*/?\*\*/?\s*$#);'
2019-11-15 09:23:51 -05:00
8746fedce4
Initialization documents: incorporate feedback from review.
...
(Thanks, Taylor!)
2019-11-15 09:00:54 -05:00
2d508f8fa5
Not const.
2019-11-10 16:14:38 -05:00
a6d22d7fc2
Improve subsys documentation; add initialization documentation.
2019-11-10 16:13:23 -05:00
52c0ab4af3
Add subsys functions for receiving/flushing states and options.
...
These functions are in the subsystem, not in the config_format_t,
since they are about how the format is _used_, not about _what it
is_.
2019-11-07 07:28:43 -05:00
7ac4f9d5ec
Give subsystems optional config formats and state formats.
...
The formats, when provided, are now added to the global config_mgr_t
objects.
2019-11-07 07:28:43 -05:00
9687efb386
Add a bunch of doxygen for things in src/lib.
2019-11-06 14:40:20 -05:00
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
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
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
39d09ea081
doxygen: add @file declarations for src/lib
...
If a file doesn't use the file command (either \file or @file),
Doxygen won't try to process it.
These declarations also turned up a doxygen warning for
crypto_ope.c; I fixed that too.
2019-10-26 11:13:29 -04:00
60213a3621
Run "make autostyle."
2019-06-05 09:33:35 -04:00
721e65a1d5
Add comments to include.am files to note where new sources go
...
This mechanism isn't perfect, and sometimes it will guess wrong,
but it will help our automation.
2019-05-02 09:37:18 -04:00
a47b61f329
Merge branch 'messaging_v3' into messaging_v3_merged
2019-03-26 20:13:49 -04:00
bdeaf7d4b2
Code to manage publish/subscribe setup via subsystem interface.
...
This commit has the necessary logic to run the publish/subscribe
system from the mainloop, and to initialize it on startup and tear
it down later.
2019-03-25 16:35:33 -04:00
2f683465d4
Bump copyright date to 2019
2019-01-16 12:33:22 -05:00
61695e3d62
Document that subsystem callbacks are optional.
2018-11-09 10:58:20 -05:00
4fe4bcf8a1
Explain that configuration should happen elsewhere, but not init.
2018-11-09 10:55:18 -05:00
cad61f0f6d
Move prefork, postfork, and thread-exit hooks into subsys
...
So far, crypto is the only module that uses them, but others are
likely to do so in the future.
2018-11-05 09:22:02 -05:00
05b54f6a6a
Use subsystems manager for subsystems used in tests.
2018-11-05 09:22:02 -05:00
7bb76b24cf
Code to manage the list of subsystems.
2018-11-05 09:22:02 -05:00
0ce1f2d466
Declare the subsystem structure.
2018-11-01 12:55:52 -04:00
Nick Mathewson