Opened 4 years ago

Closed 3 years ago

#17294 closed task (implemented)

Complete users manuals for low-level layers in tor-guts

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.2.9.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tor-docs-dev, tor-doc-lowlevel, nickm-check-done-20160905
Cc: Actual Points:
Parent ID: Points: parent
Reviewer: Sponsor: SponsorU-must

Description

Our tor-guts code (or our doxygen or whatever) should contain a complete users manual for src/common.

At the very least, we have deliverables for the crypto layer and the compat/util layer. But we should overdeliver here. This is a deliverable for November 2016

Child Tickets

TicketStatusOwnerSummaryComponent
#19294closednickmHave tor-guts cover how to use OS functionality from TorCore Tor/Tor
#19295closednickmHave tor-guts cover our cryptography functionsCore Tor/Tor
#19296closednickmHave tor-guts cover time-related util functionsCore Tor/Tor
#19297closednickmHave tor-guts cover string-related util functionsCore Tor/Tor
#19298closednickmHave tor-guts describe containersCore Tor/Tor
#19299closednickmDocument memory-related parts of src/common in tor-gutsCore Tor/Tor
#19300closednickmDocument miscellaneous things in src/common in tor-gutsCore Tor/Tor

Change History (12)

comment:1 Changed 4 years ago by nickm

Type: defecttask

comment:2 Changed 3 years ago by isabela

Sponsor: SponsorUSponsorU-must

comment:3 Changed 3 years ago by nickm

Owner: set to nickm
Status: newaccepted

comment:4 Changed 3 years ago by mikeperry

Keywords: tor-docs-dev added

comment:5 Changed 3 years ago by nickm

Keywords: tor-doc-lowlevel added

comment:6 Changed 3 years ago by isabela

Points: large6

comment:7 Changed 3 years ago by nickm

Points: 6parent
Severity: Normal

comment:8 Changed 3 years ago by nickm

Owner: nickm deleted
Status: acceptedassigned

comment:9 Changed 3 years ago by nickm

Status: assignednew

Put all unowned "assigned" tickets back into "new".

comment:10 Changed 3 years ago by nickm

Owner: set to nickm
Status: newassigned

comment:11 Changed 3 years ago by nickm

Keywords: nickm-check-done-20160905 added

Batch-tagging a bunch of tickets assigned to me: I believe these are all done or mostly done or done-enough.

comment:12 Changed 3 years ago by nickm

Resolution: implemented
Status: assignedclosed

Done

Note: See TracTickets for help on using tickets.