Document environment variable we support

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

If there is no progress in #5611 (moved) 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.

added component::applications/tor browser owner::tbb-team priority::medium severity::normal status::new type::task labels

Trac:
0001-RelativeLink.sh-Only-comments-changed.-for-comments-.patch

Trac:
Owner: erinn to mikeperry
Status: new to assigned

Trac:
Status: assigned to needs_review

Trac:
Status: needs_review to assigned
Owner: mikeperry to tbb-team

Trac:
Component: Tor bundles/installation to Tor Browser
Status: assigned to needs_review

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?

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.

Trac:
Status: needs_review to needs_revision

Set all open tickets without a severity to "Normal"

Trac:
Severity: N/A to Normal

Trac:
Summary: improve RelativeLink.sh script comments, patch attached to Document environment variable we support
Status: needs_revision to new
Cc: proper to proper, pili
Reviewer: N/A to N/A
Sponsor: N/A to N/A

Would this be something for the developer portal?

Replying to pili:

Would this be something for the developer portal?

Could be, yes.

moved to tpo/applications/tor-browser#7266 (closed)