Opened 6 years ago

Last modified 10 months ago

#7266 needs_revision task

improve RelativeLink.sh script comments, patch attached

Reported by: proper Owned by: tbb-team
Priority: Medium Milestone:
Component: Applications/Tor Browser Version:
Severity: Normal Keywords:
Cc: proper Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

I propose an improvement for RelativeLink.sh. Only comments are changed.

If there is no progress in #5611 perhaps we can at least improve the script comments?

git commit message: RelativeLink.sh: Only comments changed. ## for comments, # for commented out commands. Documented TOR_TRANSPROXY, TOR_SOCKS_HOST and TOR_SOCKS_PORT.

Child Tickets

Attachments (1)

0001-RelativeLink.sh-Only-comments-changed.-for-comments-.patch (12.3 KB) - added by proper 6 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 6 years ago by proper

Owner: changed from erinn to mikeperry
Status: newassigned

comment:2 Changed 6 years ago by mikeperry

Status: assignedneeds_review

comment:3 Changed 4 years ago by proper

Owner: changed from mikeperry to tbb-team
Status: needs_reviewassigned

comment:4 Changed 4 years ago by proper

Component: Tor bundles/installationTor Browser
Status: assignedneeds_review

comment:5 Changed 4 years ago by proper

That patch cannot be applied anymore since RelativeLink.sh heavily modified since. Would still be desirable to improve the script comments?

The -no-remote comment is now obsolete, because -no-remote that now works without.

Would still be useful to document the available environment variables?

comment:6 in reply to:  5 Changed 4 years ago by gk

Status: needs_reviewneeds_revision

Replying to proper:

Would still be useful to document the available environment variables?

Generally, yes, as we seem to introduce more and more of them. But I don't think doing that in the start script is a smart idea as it clutters it even more. Rather, adding a comment pointing to a e.g. Wiki resource containing an (up-to-date) environment variable list (+ how they should be set, what they are doing) seems a good idea to me.

comment:7 Changed 10 months ago by teor

Severity: Normal

Set all open tickets without a severity to "Normal"

Note: See TracTickets for help on using tickets.