[tor-commits] [meek/master] Comment for TOR_BROWSER_MEEK_PROFILE.

[dcf at torproject.org]

commit 488084d89003c524c84e05a2c89917351899b602
Author: David Fifield <david at bamsoftware.com>
Date:   Mon Jul 16 21:54:38 2018 -0700

    Comment for TOR_BROWSER_MEEK_PROFILE.
---
 meek-client-torbrowser/meek-client-torbrowser.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/meek-client-torbrowser/meek-client-torbrowser.go b/meek-client-torbrowser/meek-client-torbrowser.go
index 7520a0b..b02f1fc 100644
--- a/meek-client-torbrowser/meek-client-torbrowser.go
+++ b/meek-client-torbrowser/meek-client-torbrowser.go
@@ -198,6 +198,10 @@ func isBrowserProfileUpToDate(templatePath string, profilePath string) bool {
 }
 
 // Run firefox and return its exec.Cmd and stdout pipe.
+//
+// If the environment variable TOR_BROWSER_MEEK_PROFILE is set, that is used as
+// the path to the Firefox profile to use. Otherwise, the profile is chosen in a
+// platform-specific way (see linux.go, mac.go, windows.go).
 func runFirefox() (cmd *exec.Cmd, stdout io.Reader, err error) {
 	// Mac OS X needs absolute paths for firefox and for the profile.
 	var absFirefoxPath string