Opened 7 months ago

Closed 6 months ago

#32929 closed task (implemented)

Tor Manual: Split Node options into their own subsection

Reported by: teor Owned by:
Priority: Medium Milestone: Tor: 0.4.3.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: documentation tor-client manpage easy 043-can extra-review
Cc: catalyst, swati Actual Points:
Parent ID: #4310 Points: 0.5
Reviewer: catalyst, nickm Sponsor:

Description

Let'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:11

Child Tickets

Change History (12)

comment:1 Changed 6 months ago by swati

Reviewer: catalyst, teor
Status: newneeds_review

comment:2 Changed 6 months ago by swati

Added a new section called Advanced Options for grouping all the *Node related options. See PR - ​https://github.com/torproject/tor/pull/1702

Currently, there are 9 options in this section.

Some questions:

  • Is Advanced Options an appropriate title for this category?
  • Does the NodeFamily option belong to this section?

comment:3 Changed 6 months ago by catalyst

Keywords: extra-review added

Thanks!

It mostly looks good to me. I think "Node selection options" might be a better section title, because they restrict the nodes a tor client (or onion service) can use while building a circuit. There should also probably be introductory text explaining that these options can weaken your anonymity by making your client behavior different from other Tor clients.

I'll try to comment more after the weekend.

comment:4 Changed 6 months ago by teor

Reviewer: catalyst, teorcatalyst

Hi, I'm busy with Sponsor 55 right now, can you find someone else to review?

comment:5 in reply to:  4 Changed 6 months ago by swati

Taylor, please feel free to add any other reviewer to this ticket.

Replying to teor:

Hi, I'm busy with Sponsor 55 right now, can you find someone else to review?

comment:6 in reply to:  2 Changed 6 months ago by catalyst

Replying to swati:

  • Does the NodeFamily option belong to this section?

After looking at it some more, it does seem like NodeFamily belongs in this section. Anyone else have opinions on this?

comment:7 Changed 6 months ago by catalyst

Reviewer: catalystcatalyst, nickm

comment:8 in reply to:  3 ; Changed 6 months ago by swati

Taylor, I changed the section title to 'Node Selection Options', and also added some introductory text. Please review.

Replying to catalyst:

Thanks!

It mostly looks good to me. I think "Node selection options" might be a better section title, because they restrict the nodes a tor client (or onion service) can use while building a circuit. There should also probably be introductory text explaining that these options can weaken your anonymity by making your client behavior different from other Tor clients.

I'll try to comment more after the weekend.

comment:9 in reply to:  8 ; Changed 6 months ago by catalyst

Replying to swati:

Taylor, I changed the section title to 'Node Selection Options', and also added some introductory text. Please review.

Thanks!

Please also move NodeFamily to this section, as you asked about before.

Minor: I think the two sentences of introductory text should be a single paragraph, and only the sentence immediately preceding the list of options should have a colon at the end.

comment:10 in reply to:  9 Changed 6 months ago by swati

Replying to catalyst:

Taylor, I changed the section title to 'Node Selection Options', and also added some introductory text. Please review.

Thanks!

Please also move NodeFamily to this section, as you asked about before.

Minor: I think the two sentences of introductory text should be a single paragraph, and only the sentence immediately preceding the list of options should have a colon at the end.

Done both! Combined the text in the introductory paras, and added the NodeFamily option in this section.

Last edited 6 months ago by swati (previous) (diff)

comment:11 Changed 6 months ago by catalyst

Status: needs_reviewmerge_ready

Note to merger: see #32928 for special merge instructions.

comment:12 Changed 6 months ago by nickm

Resolution: implemented
Status: merge_readyclosed

Awesome! I've followed the instructions on #32928 and merged PR 1711; I believe that has merged this work too. Please reopen if I'm closing this in error.

Note: See TracTickets for help on using tickets.