The Tor Project issueshttps://gitlab.torproject.org/groups/tpo/-/issues2023-01-05T18:14:59Zhttps://gitlab.torproject.org/tpo/core/torspec/-/issues/177Create Style Guides2023-01-05T18:14:59ZMatthew FinkelCreate Style GuidesFollowing legacy/trac#26184, we should document our coding style preferences. We should consider documenting all Tor Browser-related projects.Following legacy/trac#26184, we should document our coding style preferences. We should consider documenting all Tor Browser-related projects.https://gitlab.torproject.org/tpo/applications/team/-/issues/16Create Style Guides2023-01-05T18:14:59ZMatthew FinkelCreate Style GuidesFollowing legacy/trac#26184, we should document our coding style preferences. We should consider documenting all Tor Browser-related projects.Following legacy/trac#26184, we should document our coding style preferences. We should consider documenting all Tor Browser-related projects.Sponsor 131 - Phase 5 - Ongoing Maintenancehttps://gitlab.torproject.org/tpo/applications/tor-browser/-/issues/32544Create Style Guides2023-01-05T15:49:18ZMatthew FinkelCreate Style GuidesFollowing legacy/trac#26184, we should document our coding style preferences. We should consider documenting all Tor Browser-related projects.Following legacy/trac#26184, we should document our coding style preferences. We should consider documenting all Tor Browser-related projects.Sponsor 131 - Phase 5 - Ongoing Maintenancehttps://gitlab.torproject.org/tpo/core/tor/-/issues/32510Rename .dox files to end with .md, and remove their /** magic **/2021-07-22T16:19:07ZNick MathewsonRename .dox files to end with .md, and remove their /** magic **/I thought that we had to have documentation-only doxygen files wrapped in /** and **/. But we don't: we can just tell doxygen that those files are markdown, and it will do the right thing.
We should make this change so that other tools...I thought that we had to have documentation-only doxygen files wrapped in /** and **/. But we don't: we can just tell doxygen that those files are markdown, and it will do the right thing.
We should make this change so that other tools (like github) that have special handling for markdown can pretty-print our markdown files, and so that we can eventually incorporate some/all of doc/HACKING into our doxygen.Tor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32474Remove CodeStructure.md once I'm sure that it is subsumed by intro.html2021-07-22T16:19:07ZNick MathewsonRemove CodeStructure.md once I'm sure that it is subsumed by intro.htmlTor: 0.4.4.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32455Run "make doxygen" in a travis builder2021-07-22T16:19:07ZNick MathewsonRun "make doxygen" in a travis builderWith legacy/trac#32385, we now have --enable-fatal-warnings behave sensibly with doxygen warnings. We can prevent ourselves from introducing new doxygen warnings by having a travis builder that does "make doxygen".
This won't apply to ...With legacy/trac#32385, we now have --enable-fatal-warnings behave sensibly with doxygen warnings. We can prevent ourselves from introducing new doxygen warnings by having a travis builder that does "make doxygen".
This won't apply to warnings about missing documentation: those are off by default, since we have a few thousand of them.Tor: 0.4.3.x-finalrl1987rl1987https://gitlab.torproject.org/tpo/applications/tor-browser-build/-/issues/32416Add some documentation about building go libraries/programs with build_go_lib2023-01-05T14:16:24ZboklmAdd some documentation about building go libraries/programs with build_go_libAs `build_go_lib` template is getting more complex, we should add some documentation about how to use it, probably into 'README.HACKING'.As `build_go_lib` template is getting more complex, we should add some documentation about how to use it, probably into 'README.HACKING'.https://gitlab.torproject.org/tpo/core/tor/-/issues/32385doxygen: respect --enable-fatal-warnings2021-07-22T16:19:07ZNick Mathewsondoxygen: respect --enable-fatal-warningsDoxygen has an option to fail with an error if any warning message occurs. We can enable it, if we disable missing documentation warnings. We should have another option to turn missing documentation warnings back on.Doxygen has an option to fail with an error if any warning message occurs. We can enable it, if we disable missing documentation warnings. We should have another option to turn missing documentation warnings back on.Tor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32378Doxygen: fix \refdir output2021-07-22T16:19:07ZNick MathewsonDoxygen: fix \refdir outputI thought that I had a working `\refdir` command for doxygen that would generate correct links to directory documentation, even in out-of-tree builds. Unfortunately, it only worked for out-of-tree builds whose `@srcdir@` did not contain...I thought that I had a working `\refdir` command for doxygen that would generate correct links to directory documentation, even in out-of-tree builds. Unfortunately, it only worked for out-of-tree builds whose `@srcdir@` did not contain the string `../`.Tor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/community/team/-/issues/8Template letter to universities to unblock Tor2023-11-24T11:56:40ZGusTemplate letter to universities to unblock TorSome universities are blocking torproject.org and also the Tor network.
If we create a template letter, I think many students and teachers will feel engaged to formalize and fill some papers to request to unblock Tor at their universiti...Some universities are blocking torproject.org and also the Tor network.
If we create a template letter, I think many students and teachers will feel engaged to formalize and fill some papers to request to unblock Tor at their universities. And even if the university doesn't unblock at least it will require a formal answer from the university. Thoughts?Roger DingledineRoger Dingledine2023-12-01https://gitlab.torproject.org/tpo/web/support/-/issues/81[Windows] Improve documentation for compiling local site via Lektor2021-08-23T16:30:13ZMac Tavish[Windows] Improve documentation for compiling local site via LektorMany users can't compile the local site because of lektor errors. Please review the instructions and add the errors (reported by users) and their solutions in troubleshooting section.
If you have any errors, please report them so we can...Many users can't compile the local site because of lektor errors. Please review the instructions and add the errors (reported by users) and their solutions in troubleshooting section.
If you have any errors, please report them so we can document them. Be sure to mention your platform as well.
I have attached a file, please review it and include its content in the instructions
[Local_site_compilation_instruction_draft.txt](/uploads/b97f9042f3fc6d0c6a77a455c5cf10f6/Local_site_compilation_instruction_draft.txt)
**Disclaimer:** *Written by a Windows User, there might be some difference depending upon your platform.*
**Edit:** **I have updated the attachment file.**https://gitlab.torproject.org/tpo/core/tor/-/issues/32307Most every C file needs a doxygen @file declaration2021-07-22T16:19:07ZNick MathewsonMost every C file needs a doxygen @file declarationDoxygen does not generate any documentation for files that do not say @file or \file. We have dozens of those right now.Doxygen does not generate any documentation for files that do not say @file or \file. We have dozens of those right now.Tor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32306check-local target to enforce doxygen-correctness2022-06-17T13:03:34ZNick Mathewsoncheck-local target to enforce doxygen-correctnessWe should have a check-local target that makes sure we haven't regressed anything in Doxygen. I'm going to compile a list of what that means here, and then make the target later in November.
Current properties are:
* Every C and H f...We should have a check-local target that makes sure we haven't regressed anything in Doxygen. I'm going to compile a list of what that means here, and then make the target later in November.
Current properties are:
* Every C and H file (outside of ext, trunnel, and test) should have a @file or \file declaration.
* @file or \file declarations should match the actual name of the file.
* There should be no doxygen warnings (except for missing documentation).https://gitlab.torproject.org/tpo/core/tor/-/issues/32277tor manpage: reword command-line options and description; improve formatting2021-07-22T16:19:07ZTaylor Yutor manpage: reword command-line options and description; improve formattingApply most of the wording improvements from legacy/trac#31943 to COMMAND-LINE OPTIONS and DESCRIPTION. Also improve formatting in these sections to make option names appear with fixed-width font in the HTML version.
Did not apply tense...Apply most of the wording improvements from legacy/trac#31943 to COMMAND-LINE OPTIONS and DESCRIPTION. Also improve formatting in these sections to make option names appear with fixed-width font in the HTML version.
Did not apply tense changes from imperative to descriptive present tense. Changed a few existing inconsistent uses of present tense to imperative.Tor: 0.4.3.x-finalTaylor YuTaylor Yuhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32211write description of subsystem initialization/shutdown architecture2021-07-22T16:19:07ZTaylor Yuwrite description of subsystem initialization/shutdown architectureTor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32209write description of config subsystem architecture2021-07-22T16:19:07ZTaylor Yuwrite description of config subsystem architectureTor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32208write description of control subsystem architecture2022-06-17T14:13:18ZTaylor Yuwrite description of control subsystem architecturehttps://gitlab.torproject.org/tpo/core/tor/-/issues/32207write description of pub-sub architecture2021-07-22T16:19:26ZTaylor Yuwrite description of pub-sub architectureTor: 0.4.3.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32206write high-level outline of target modular tor architecture2021-07-22T16:19:26ZTaylor Yuwrite high-level outline of target modular tor architectureTor: 0.4.3.x-finalTaylor YuTaylor Yuhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32176tor manpage: reword FILES and back matter2021-07-22T16:19:26ZTaylor Yutor manpage: reword FILES and back matterIncorporate most of the rewording changes from legacy/trac#31943 for the FILES, SEE ALSO, and BUGS sections of the tor.1.txt manpage.
Includes some formatting changes to make file names display with fixed-width font in the HTML version....Incorporate most of the rewording changes from legacy/trac#31943 for the FILES, SEE ALSO, and BUGS sections of the tor.1.txt manpage.
Includes some formatting changes to make file names display with fixed-width font in the HTML version.
Also delete a redundant entry for DataDirectory/approved-routers.Tor: 0.4.3.x-finalTaylor YuTaylor Yu