code review 556041: install.html: elaborate on shell profile instructions

install.html: elaborate on shell profile instructions

[adg, 2010-03-14 23:16:58]

Hello r, rsc (cc: golang-dev@googlegroups.com),

I'd like you to review this change.

[james toy, 2010-03-15 11:17:38]

Hi,
      FWIW I have been using this all along on all of the supported
platforms except arm and it has been working fine.

LGTM

-james toy-

On Sunday, March 14, 2010,  <adg@golang.org> wrote:
> Reviewers: r, rsc,
>
> Message:
> Hello r, rsc (cc: golang-dev@googlegroups.com),
>
> I'd like you to review this change.
>
>
> Description:
> install.html: suggest .profile instead of .bashrc
>
> This works more universally, and thus should reduce the
> installation issues experienced by some.
>
> Please review this at http://codereview.appspot.com/556041/show
>
> Affected files:
>   M doc/install.html
>
>
> Index: doc/install.html
> ===================================================================
> --- a/doc/install.html
> +++ b/doc/install.html
> @@ -20,7 +20,7 @@
>  <h2>Environment variables</h2>
>
>  <p>The Go compilation environment depends on three environment
> -variables that you should set in your <code>.bashrc</code> or equivalent,
> +variables that you should set in your <code>.profile</code> or equivalent,
>  plus one optional variable:</p>
>
>  <dl>
> @@ -106,7 +106,8 @@
>  </p>
>
>  <p>
> -Set these variables in your <code>.bashrc</code>.  For example:
> +Set these variables in <code>$HOME/.profile</code> or equivalent.
> +For example:
>  </p>
>
>  <pre>
>
>
>

[r2, 2010-03-15 14:59:32]

I thought bash used .bash_profile.  There's probably some nuance but you can
avoid by saying 'in your shell profile'.

-rob

[rsc, 2010-03-15 17:10:32]

.bashrc and .profile are not the same thing.
.bashrc runs on every bash shell.
.profile runs only on login (and if using bash, only if .bash_profile
does not exist).
In windowed environments it's often quite hard to get
a .profile or .bash_profile to rerun (you have to log in again)
but easy to get .bashrc rerun (you open a new window).

I agree with Rob that you can finesse the issue by saying
"in your shell profile," but we should keep the reference
to .bashrc, because it *is* working for so many people.
Many people who try to install Go don't know what
a shell profile is, and some don't know about environment
variables.  I don't want to remove detail here.
How about something like:

... in your shell profile ($HOME/.bashrc or $HOME/.profile or equivalent).

Russ




On Sun, Mar 14, 2010 at 15:16,  <adg@golang.org> wrote:
> Reviewers: r, rsc,
>
> Message:
> Hello r, rsc (cc: golang-dev@googlegroups.com),
>
> I'd like you to review this change.
>
>
> Description:
> install.html: suggest .profile instead of .bashrc
>
> This works more universally, and thus should reduce the
> installation issues experienced by some.
>
> Please review this at http://codereview.appspot.com/556041/show
>
> Affected files:
>  M doc/install.html
>
>
> Index: doc/install.html
> ===================================================================
> --- a/doc/install.html
> +++ b/doc/install.html
> @@ -20,7 +20,7 @@
>  <h2>Environment variables</h2>
>
>  <p>The Go compilation environment depends on three environment
> -variables that you should set in your <code>.bashrc</code> or equivalent,
> +variables that you should set in your <code>.profile</code> or equivalent,
>  plus one optional variable:</p>
>
>  <dl>
> @@ -106,7 +106,8 @@
>  </p>
>
>  <p>
> -Set these variables in your <code>.bashrc</code>.  For example:
> +Set these variables in <code>$HOME/.profile</code> or equivalent.
> +For example:
>  </p>
>
>  <pre>
>
>
>

[adg, 2010-03-15 22:24:35]

Hello r, rsc (cc: golang-dev@googlegroups.com),

Please take another look.

[rsc, 2010-03-15 22:26:47]

LGTM
(but wait for r)

[adg, 2010-03-15 22:27:01]

I removed the first reference to .bashrc as it seemed redundant, and
elaborated in the second (now only) instance.

On 16 March 2010 09:24,  <adg@golang.org> wrote:
> Hello r, rsc (cc: golang-dev@googlegroups.com),
>
> Please take another look.
>
>
> http://codereview.appspot.com/556041/show
>

[r, 2010-03-15 22:36:03]

LGTM

http://codereview.appspot.com/556041/diff/9001/10001
File doc/install.html (right):

http://codereview.appspot.com/556041/diff/9001/10001#newcode110
doc/install.html:110: <code>$HOME/.profile</code>, or equivalent). For example:
this isn't really an example of the previous sentence.
s/For example/The settings might look something like this:/

[adg, 2010-03-15 22:42:38]

*** Submitted as http://code.google.com/p/go/source/detail?r=607029c0c3b4 ***

install.html: elaborate on shell profile instructions

R=r, rsc
CC=golang-dev
http://codereview.appspot.com/556041

[james toy, 2010-03-16 12:37:07]

On Mon, Mar 15, 2010 at 13:10, Russ Cox <rsc@golang.org> wrote:

> .bashrc and .profile are not the same thing.
> .bashrc runs on every bash shell.
> .profile runs only on login (and if using bash, only if .bash_profile
> does not exist).
> In windowed environments it's often quite hard to get
> a .profile or .bash_profile to rerun (you have to log in again)
> but easy to get .bashrc rerun (you open a new window).
>

agreed; however, standard mac os x terminal.app does not exhibit this
behavior (though i bet the xterm in the X11 implementation does).  if you
open a new tab / window / terminal -- it always rereads the .profile (i
think it runs them as login shells).


>
> I agree with Rob that you can finesse the issue by saying
> "in your shell profile," but we should keep the reference
> to .bashrc, because it *is* working for so many people.
> Many people who try to install Go don't know what
> a shell profile is, and some don't know about environment
> variables.  I don't want to remove detail here.
> How about something like:
>
> ... in your shell profile ($HOME/.bashrc or $HOME/.profile or equivalent).


i think profile is a more elegant solution -- but for the "just works"
factor the .bashrc is certainly doing the trick.  i do think anymore
documentation on this is off-topic so i think your solution is good.

LGTM

james toy


>
>
> On Sun, Mar 14, 2010 at 15:16,  <adg@golang.org> wrote:
> > Reviewers: r, rsc,
> >
> > Message:
> > Hello r, rsc (cc: golang-dev@googlegroups.com),
> >
> > I'd like you to review this change.
> >
> >
> > Description:
> > install.html: suggest .profile instead of .bashrc
> >
> > This works more universally, and thus should reduce the
> > installation issues experienced by some.
> >
> > Please review this at http://codereview.appspot.com/556041/show
> >
> > Affected files:
> >  M doc/install.html
> >
> >
> > Index: doc/install.html
> > ===================================================================
> > --- a/doc/install.html
> > +++ b/doc/install.html
> > @@ -20,7 +20,7 @@
> >  <h2>Environment variables</h2>
> >
> >  <p>The Go compilation environment depends on three environment
> > -variables that you should set in your <code>.bashrc</code> or
> equivalent,
> > +variables that you should set in your <code>.profile</code> or
> equivalent,
> >  plus one optional variable:</p>
> >
> >  <dl>
> > @@ -106,7 +106,8 @@
> >  </p>
> >
> >  <p>
> > -Set these variables in your <code>.bashrc</code>.  For example:
> > +Set these variables in <code>$HOME/.profile</code> or equivalent.
> > +For example:
> >  </p>
> >
> >  <pre>
> >
> >
> >
>