The Tor Project issueshttps://gitlab.torproject.org/groups/tpo/-/issues2021-09-08T14:14:16Zhttps://gitlab.torproject.org/tpo/network-health/metrics/library/-/issues/40007Improve javadoc documentation for ExtraInfoDescriptor and ExtraInfoDescriptor...2021-09-08T14:14:16ZHiroImprove javadoc documentation for ExtraInfoDescriptor and ExtraInfoDescriptorImp classes- Improve javadoc documentation
- Write missing class docs
- If possible use javadoc best practices- Improve javadoc documentation
- Write missing class docs
- If possible use javadoc best practicesImprove javadoc documentationHiroHirohttps://gitlab.torproject.org/tpo/core/tor/-/issues/40418Man page no longer accurate for onion authorization instructions2022-05-09T16:35:19ZnyxnorMan page no longer accurate for onion authorization instructions[2019 TPO docs](https://2019.www.torproject.org/docs/tor-manual.html.en)
Outdated:
> Client Authorization
> Revoking a client can be done by removing their ".auth" file, however the revocation will be in effect only after the tor proce...[2019 TPO docs](https://2019.www.torproject.org/docs/tor-manual.html.en)
Outdated:
> Client Authorization
> Revoking a client can be done by removing their ".auth" file, however the revocation will be in effect only after the tor process gets restarted even if a SIGHUP takes place.
Revoking a key does work with sighup now.Developer portalSilvio RhattoSilvio Rhattohttps://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40090Recommend bwauths to set their systems to UTC timezone2021-07-01T12:37:51ZjugaRecommend bwauths to set their systems to UTC timezonesbws: 1.2.x-finaljugajugahttps://gitlab.torproject.org/tpo/network-health/onbasca/-/issues/14Update all docs2023-11-13T16:21:44ZjugaUpdate all docsonbasca: 1.0jugajugahttps://gitlab.torproject.org/tpo/network-health/onbasca/-/issues/6Add docstrings2023-03-17T11:19:27ZjugaAdd docstringsonbasca: 1.0https://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40069Ensure `recent` KeyValues behaviour is updated in the bandwidth file specific...2021-04-08T15:26:51ZjugaEnsure `recent` KeyValues behaviour is updated in the bandwidth file specificationsbws: 1.2.x-finalhttps://gitlab.torproject.org/tpo/web/dev/-/issues/9Make more accessible Core Tor documentation2022-03-14T18:50:57ZjugaMake more accessible Core Tor documentationThere's Core Tor documentation distributed in three (at least) sources. Even if it's documentation intended for developers, it'd be great that it would be more accessible by providing the HTML version online and using some torproject.org...There's Core Tor documentation distributed in three (at least) sources. Even if it's documentation intended for developers, it'd be great that it would be more accessible by providing the HTML version online and using some torproject.org subdomain or path or links.
The sources are:
- The HTML that can be generated from little-t tor code (with doxygen): https://people.torproject.org/~nickm/tor-auto/doxygen/
- Nickm's torgut repository: https://gitweb.torproject.org/user/nickm/torguts.git/tree/. Files are in markdown, the can be converted to HTML.
- The documentation included in little-t tor code: https://gitweb.torproject.org/tor.git/tree/doc/HACKING (also markdown).
I can provide scripts to generate/convert the documentation automatically.
We would need to decide where to put it, maybe get subdomain and get access to the server where it would live.Developer portalhttps://gitlab.torproject.org/tpo/core/tor/-/issues/40044doc: Move manpages to doc/man/2021-07-22T16:18:20ZDavid Gouletdgoulet@torproject.orgdoc: Move manpages to doc/man/In an attempt to bring order to chaos in `doc/`, I would like to move the manpages to their directory named `man/`. It is a common practice to put all manpages in one place and usually it is `man/`.
This is quite simple change.In an attempt to bring order to chaos in `doc/`, I would like to move the manpages to their directory named `man/`. It is a common practice to put all manpages in one place and usually it is `man/`.
This is quite simple change.Tor: unspecifiedDavid Gouletdgoulet@torproject.orgDavid Gouletdgoulet@torproject.orghttps://gitlab.torproject.org/tpo/network-health/sbws/-/issues/40002Change the references to git.tpo to Gitlab git in the documentation2021-08-09T15:46:54ZjugaChange the references to git.tpo to Gitlab git in the documentationsbws: unspecifiedGeorg KoppenGeorg Koppenhttps://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/anti-censorship/bridgedb/-/issues/12507Automate BridgeDB documentation builds2022-03-01T17:35:40ZIsis LovecruftAutomate BridgeDB documentation buildsThe developer documentation for BridgeDB needs a place to live. Currently, Sphinx builds can be manually triggered to produce HTML documentation (as well as other types). I have been manually scp'ing it to https://para.noid.cat/bridgedb,...The developer documentation for BridgeDB needs a place to live. Currently, Sphinx builds can be manually triggered to produce HTML documentation (as well as other types). I have been manually scp'ing it to https://para.noid.cat/bridgedb, mostly because I had no idea where to put it, but wanted to put it somewhere.
So...
1. We should probably ask TPO's sysadmins to create something like https://docs.torproject.org/bridgedb, or wherever people want to use for keeping common developer documentation.
2. I think there was some sort of funding for this. I've just been doing this because I needed to understand how BridgeDB works and it was entirely undocumented when I started working on it. If someone knows who that funder is, please comment/tag this ticket as appropriate.
3. Documentation builds should probably be triggered automatically when a new signed tag is pushed to `git.torproject.org/bridgedb.git`.Developer portalhttps://gitlab.torproject.org/tpo/community/support/-/issues/23565document signs of client clock skew to ease troubleshooting2022-03-01T18:22:08ZTaylor Yudocument signs of client clock skew to ease troubleshootingTicket legacy/trac#23508 describes some ways that clock skews during client bootstrapping can often cause stalls without any useful user feedback. Document some signs of this behavior (e.g., specific message patterns in log files, Tor L...Ticket legacy/trac#23508 describes some ways that clock skews during client bootstrapping can often cause stalls without any useful user feedback. Document some signs of this behavior (e.g., specific message patterns in log files, Tor Launcher messages when stalled) so we can better help users who aren't running a modern enough release to mitigate these issues.Tor: unspecifiedhttps://gitlab.torproject.org/tpo/network-health/sbws/-/issues/29752Document new sbws Gitlab labels2022-02-18T20:48:05ZjugaDocument new sbws Gitlab labelssbws: unspecifiedhttps://gitlab.torproject.org/tpo/network-health/sbws/-/issues/29718Include a refactor plan2022-02-17T08:49:03ZjugaInclude a refactor planThe parent ticket have some children tickets and we collected some ideas in https://pad.riseup.net/p/rGfvR7ZsvtoZ, but there are other ideas not collected.The parent ticket have some children tickets and we collected some ideas in https://pad.riseup.net/p/rGfvR7ZsvtoZ, but there are other ideas not collected.sbws: unspecifiedhttps://gitlab.torproject.org/tpo/network-health/sbws/-/issues/28990Move all or part of the documentation about Tor and the bandwidth scanner2022-03-01T15:26:38ZjugaMove all or part of the documentation about Tor and the bandwidth scannerI've writing documentation in https://onbasca.readthedocs.io/ that i didn't know where else could go.
Some of it might be useful only for me but some might be useful for other people and should be in Tor project domain.I've writing documentation in https://onbasca.readthedocs.io/ that i didn't know where else could go.
Some of it might be useful only for me but some might be useful for other people and should be in Tor project domain.sbws: 2.0.x-final-oldhttps://gitlab.torproject.org/tpo/core/fallback-scripts/-/issues/24790When 0.2.5 is EOL, remove the fallback script comment that refers to 0.2.8 an...2020-06-27T14:11:40ZteorWhen 0.2.5 is EOL, remove the fallback script comment that refers to 0.2.8 and earlierWe don't accept unsupported Tor versions as fallbacks, so there's no reason to talk about other bugs in unsupported versions.We don't accept unsupported Tor versions as fallbacks, so there's no reason to talk about other bugs in unsupported versions.Tor: 0.3.4.x-finalNick MathewsonNick Mathewsonhttps://gitlab.torproject.org/tpo/core/tor/-/issues/33741Format code blocks inside markdown files (documentation)2021-07-22T16:18:20ZGhost UserFormat code blocks inside markdown files (documentation)There are issues with code blocks inside some *.md files (some files use code blocks syntax, some do not). First of all, it's not consistent but what's really bad is when *.md file is being displayed incorrectly. You can find an example ...There are issues with code blocks inside some *.md files (some files use code blocks syntax, some do not). First of all, it's not consistent but what's really bad is when *.md file is being displayed incorrectly. You can find an example of what I'm saying in CodingStandards.md under How we log changes section.
​https://github.com/torproject/tor/blob/master/doc/HACKING/CodingStandards.md#how-we-log-changes
Part of the git log output is still displayed as a regular text rather than a formatted code block.
Goal of this ticket is to go through all *.md files under `doc` and `doc/HACKING` directories and format code snippets accordingly.
```
```c
// code snippet
// written in
// C language
```
```
```
```bash
// command to be run
// inside bash
```
```
This should fix the issues described above and enable syntax highlighting on supported websites and editors.Tor: unspecifiedGuinnessGuinnesshttps://gitlab.torproject.org/tpo/core/tor/-/issues/33339Add script to check ordering of options in manpage2021-07-22T16:18:20ZTaylor YuAdd script to check ordering of options in manpageAdd a script to check the ordering of option names within a manpage section.
This will be an initial version that doesn't restrict section names and doesn't recognize pragma comments that mark intentionally out-of-order option names.
l...Add a script to check the ordering of option names within a manpage section.
This will be an initial version that doesn't restrict section names and doesn't recognize pragma comments that mark intentionally out-of-order option names.
legacy/trac#32621 will contain a more fully-functional script suitable for automation.Tor: 0.4.3.x-finalTaylor YuTaylor Yuhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32971Document OwningControllerProcess time interval2021-07-22T16:18:20ZteorDocument OwningControllerProcess time intervalTor checks for its owning controller process every 15 seconds:
https://github.com/torproject/tor/blob/4f02812242d1fd90d859eb98ac3fb1ed182f18cf/src/lib/evloop/procmon.c#L168
We should document this interval in the man page.Tor checks for its owning controller process every 15 seconds:
https://github.com/torproject/tor/blob/4f02812242d1fd90d859eb98ac3fb1ed182f18cf/src/lib/evloop/procmon.c#L168
We should document this interval in the man page.Tor: 0.4.3.x-finalhttps://gitlab.torproject.org/tpo/core/tor/-/issues/32929Tor Manual: Split Node options into their own subsection2021-07-22T16:19:08ZteorTor Manual: Split Node options into their own subsectionLet's put the client *Node* and GeoIPExcludeUnknown options in their own manpage section.
For context, see:
https://trac.torproject.org/projects/tor/ticket/32846#comment:11Let's put the client *Node* and GeoIPExcludeUnknown options in their own manpage section.
For context, see:
https://trac.torproject.org/projects/tor/ticket/32846#comment:11Tor: 0.4.3.x-final