Bug 11968 - remove oe-init-build-env-memres from documentation
Summary: remove oe-init-build-env-memres from documentation
Status: RESOLVED FIXED
Alias: None
Product: General Docs
Classification: Documentation
Component: docs-general (show other bugs)
Version: 2.4
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 2.4 M4
Assignee: Kristi
QA Contact:
URL:
Whiteboard: 21 Sept 2017: RESOLVED
Depends on:
Blocks:
 
Reported: 2017-08-23 17:10 UTC by Leonardo Sandoval Gonzalez
Modified: 2017-09-21 16:41 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Leonardo Sandoval Gonzalez 2017-08-23 17:10:01 UTC
The 'memres' setup script was removed recently [1] thus the 2.4 final documentation should not reference it. Doing a recursive grep inside yocto-docs, most manuals (adt-manual, bsp-guide, dev-manual, kernel-dev, ref-manual, sdk-manual) have references to this script.

[1] http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=0ad65be8bffaa84042c170b46ca320d0a69f012e
Comment 1 Scott Rifenbark 2017-08-23 17:19:11 UTC
This script is in a lot of places... I will get it out.

Thanks.
Comment 2 Kristi 2017-08-29 22:40:11 UTC
Assigning to myself.
Comment 3 Scott Rifenbark 2017-09-21 15:22:28 UTC
Can anyone tell me if the BBSERVER (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-BBSERVER) variable is now gone as well?  I am assuming it is no longer used as oe-init-build-env-memres is out.

Scott
Comment 4 Leonardo Sandoval Gonzalez 2017-09-21 15:35:37 UTC
(In reply to comment #3)
> Can anyone tell me if the BBSERVER
> (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-
> BBSERVER) variable is now gone as well?  I am assuming it is no longer used
> as oe-init-build-env-memres is out.
> 
> Scott

variable is used in other places: some examples: 1. bitbake --remote-server defaults to BBSERVER if present on environment 2. it is included as part of BB_HASHBASE_WHITELIST. CC Paul/RP.
Comment 5 Scott Rifenbark 2017-09-21 15:36:56 UTC
Also, the OE_INIT_ENV_SCRIPT (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-OE_INIT_ENV_SCRIPT) variable implies multiple setup scripts.  Now that we have just the one, is this description appropriate?  Or is the variable still used?

Scott
Comment 6 Richard Purdie 2017-09-21 15:54:29 UTC
(In reply to comment #5)
> Also, the OE_INIT_ENV_SCRIPT
> (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-
> OE_INIT_ENV_SCRIPT) variable implies multiple setup scripts.  Now that we
> have just the one, is this description appropriate?  Or is the variable
> still used?

People can still add their own script so yes, this is still fine as is.
Comment 7 Scott Rifenbark 2017-09-21 15:56:10 UTC
(In reply to comment #4)
> (In reply to comment #3)
> > Can anyone tell me if the BBSERVER
> > (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-
> > BBSERVER) variable is now gone as well?  I am assuming it is no longer used
> > as oe-init-build-env-memres is out.
> > 
> > Scott
> 
> variable is used in other places: some examples: 1. bitbake --remote-server
> defaults to BBSERVER if present on environment 2. it is included as part of
> BB_HASHBASE_WHITELIST. CC Paul/RP.

Please look this new definition for BBSERVER over and let me know if it is okay - http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-BBSERVER.
Comment 8 Leonardo Sandoval Gonzalez 2017-09-21 16:04:16 UTC
(In reply to comment #7)
> (In reply to comment #4)
> > (In reply to comment #3)
> > > Can anyone tell me if the BBSERVER
> > > (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-
> > > BBSERVER) variable is now gone as well?  I am assuming it is no longer used
> > > as oe-init-build-env-memres is out.
> > > 
> > > Scott
> > 
> > variable is used in other places: some examples: 1. bitbake --remote-server
> > defaults to BBSERVER if present on environment 2. it is included as part of
> > BB_HASHBASE_WHITELIST. CC Paul/RP.
> 
> Please look this new definition for BBSERVER over and let me know if it is
> okay -
> http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-BBSERVER.

I believe this piece is also useful:

"The variable should have the following format and exported as:

     export BBSERVER=localhost:$port"

it gives a nice example of the url syntax (quite known but useful for new users)
Comment 9 Scott Rifenbark 2017-09-21 16:32:23 UTC
(In reply to comment #8)
> (In reply to comment #7)
> > (In reply to comment #4)
> > > (In reply to comment #3)
> > > > Can anyone tell me if the BBSERVER
> > > > (http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-
> > > > BBSERVER) variable is now gone as well?  I am assuming it is no longer used
> > > > as oe-init-build-env-memres is out.
> > > > 
> > > > Scott
> > > 
> > > variable is used in other places: some examples: 1. bitbake --remote-server
> > > defaults to BBSERVER if present on environment 2. it is included as part of
> > > BB_HASHBASE_WHITELIST. CC Paul/RP.
> > 
> > Please look this new definition for BBSERVER over and let me know if it is
> > okay -
> > http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-BBSERVER.
> 
> I believe this piece is also useful:
> 
> "The variable should have the following format and exported as:
> 
>      export BBSERVER=localhost:$port"
> 
> it gives a nice example of the url syntax (quite known but useful for new
> users)

Ok Thanks... see http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-BBSERVER for the update.  If this is good then I believe I can RESOLVE this issue as I have purged the manual set of all "oe-init-build-env-memres" information.  Let me know.  Thanks.
Comment 10 Leonardo Sandoval Gonzalez 2017-09-21 16:37:21 UTC
> 
> Ok Thanks... see
> http://www.yoctoproject.org/docs/2.4/ref-manual/ref-manual.html#var-BBSERVER
> for the update.  If this is good then I believe I can RESOLVE this issue as
> I have purged the manual set of all "oe-init-build-env-memres" information. 
> Let me know.  Thanks.

Looks good to me, thanks.
Comment 11 Scott Rifenbark 2017-09-21 16:41:22 UTC
Thanks for the quick reviews!  I am setting to RESOLVED and marking the docs flag as done.

Scott