[yocto] yocto docs: confusion between shell env vars and bitbake env vars

[Rifenbark, Scott M]

I clarified about 5 instances of this problem in the reference manual.  As usual, see http://www.yoctoprojects.org/docs/latest/poky-ref-manual/poky-ref-manual.html for the latest.

Scott


-----Original Message-----
From: yocto-bounces at yoctoproject.org [mailto:yocto-bounces at yoctoproject.org] On Behalf Of Robert P. J. Day
Sent: Thursday, March 22, 2012 9:29 AM
To: Yocto discussion list
Subject: [yocto] yocto docs: confusion between shell env vars and bitbake env vars


  since i'm reading this out of the yocto/poky reference manual, i
might as well point it out here.

  there is occasional confusion when the docs refer to "environment
variables", since it's not clear when that means *shell* env vars or
*bitbake* env vars.  for instance, in the ref manual, section B.1,
"Parsing", you read:

"The first thing BitBake does is look for the bitbake.conf file. The
Yocto Project keeps this file in the Yocto Project file's meta/conf/
directory. BitBake finds it by examining the BBPATH environment
variable and looking for the meta/conf/ directory."

  but there is no BBPATH shell environment variable.  in fact,
oe-init-build-env explicitly *unsets* that shell variable at the very
end.

  however, you can check the *bitbake* environment with "bitbake -e"
and there it is, and i think that not being clear about the difference
has the potential to massively confuse readers.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
yocto mailing list
yocto at yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto