Opened 2 years ago

Closed 2 years ago

#23515 closed defect (implemented)

remove inappropriate paragraph in GettingStarted.md

Reported by: merge Owned by:
Priority: Very Low Milestone: Tor: 0.3.2.x-final
Component: Core Tor/Tor Version: Tor: unspecified
Severity: Trivial Keywords: doc
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

doc/HACKING/GettingStarted.md says "you might like reading doc/HACKING", which is reader obviously is already doing :)

Let' remove the paragraph containing this line as it adds no information at all.

Child Tickets

Change History (13)

comment:1 Changed 2 years ago by merge

Status: newneeds_review

comment:2 Changed 2 years ago by catalyst

Yeah that does seem redundant. However, I think the more detailed information dump that the existing text intends to refer to is actually the torguts repository. (which arguably should be under doc/ in the tor repository rather than its own repository)

comment:3 Changed 2 years ago by merge

The torguts repo is a great read. I think it really should move inside tor's doc directory. It would probably be a little better maintained that way too.

Tor doesn't yet use git modules for external repositories, so I guess that would add totally unnecessary complexity.

If simply adding doc/torguts/ with the current torguts files, we'd have to make sure, the current torguts repo is deleted.

comment:4 Changed 2 years ago by catalyst

A related ticket is #22911, but I'm not sure we have a ticket for moving the rest of torguts into the main tor repository.

comment:5 Changed 2 years ago by merge

ok. strictly speaking moving torguts to tor/doc is a seperate issue. In case that'd be done, of course some texts will link to it.

Or was this "you might like reading doc/HACKING" really meant to say "you might like reading https://gitweb.torproject.org/user/nickm/torguts.git/ ?

comment:6 in reply to:  5 Changed 2 years ago by catalyst

Status: needs_reviewneeds_revision

Replying to merge:

Or was this "you might like reading doc/HACKING" really meant to say "you might like reading https://gitweb.torproject.org/user/nickm/torguts.git/ ?

Yes, at least until we decide to move the torguts content into the tor repository. doc/HACKING/README.1st.md also mentions torguts.git under a "XXXXX also describe" heading, but I'm not sure that needs to change as part of this ticket.

comment:7 Changed 2 years ago by merge

the torguts repo is directly linked a few lines below though, in the very same file, GettingStarted.md; number 2 of "Getting your first patch into Tor". Wouldn't it be unnecessary to have it on top too?

comment:8 Changed 2 years ago by catalyst

I think it's fine to mention it both up top and later on in "Getting your first patch into Tor", but only provide the full repository URL in one place.

comment:9 Changed 2 years ago by dgoulet

Milestone: Tor: 0.3.2.x-final

comment:10 Changed 2 years ago by merge

Status: needs_revisionneeds_review

comment:11 Changed 2 years ago by nickm

Resolution: implemented
Status: needs_reviewclosed

applied!

Note: See TracTickets for help on using tickets.