Opened 8 years ago
Last modified 5 months ago
#7266 new task
Document environment variable we support
| Reported by: | proper | Owned by: | tbb-team |
|---|---|---|---|
| Priority: | Medium | Milestone: | |
| Component: | Applications/Tor Browser | Version: | |
| Severity: | Normal | Keywords: | |
| Cc: | proper, pili | 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)
Change History (11)
Changed 8 years ago by
| Attachment: | 0001-RelativeLink.sh-Only-comments-changed.-for-comments-.patch added |
|---|
comment:1 Changed 8 years ago by
| Owner: | changed from erinn to mikeperry |
|---|---|
| Status: | new → assigned |
comment:2 Changed 8 years ago by
| Status: | assigned → needs_review |
|---|
comment:3 Changed 5 years ago by
| Owner: | changed from mikeperry to tbb-team |
|---|---|
| Status: | needs_review → assigned |
comment:4 Changed 5 years ago by
| Component: | Tor bundles/installation → Tor Browser |
|---|---|
| Status: | assigned → needs_review |
comment:5 follow-up: 6 Changed 5 years ago by
comment:6 Changed 5 years ago by
| Status: | needs_review → needs_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 2 years ago by
| Severity: | → Normal |
|---|
Set all open tickets without a severity to "Normal"
comment:8 Changed 6 months ago by
| Cc: | pili added |
|---|---|
| Status: | needs_revision → new |
| Summary: | improve RelativeLink.sh script comments, patch attached → Document environment variable we support |
That patch cannot be applied anymore since RelativeLink.sh heavily modified since. Would still be desirable to improve the script comments?
The
-no-remotecomment is now obsolete, because-no-remotethat now works without.Would still be useful to document the available environment variables?