| Summary: | Need to document usage of buildtools-tarball | ||
|---|---|---|---|
| Product: | [Documentation] Development Manual | Reporter: | Richard Purdie <richard.purdie> |
| Component: | development | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | VERIFIED FIXED | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | High | CC: | alexandrux.palalau, elizabeth.flanagan, jessica.zhang, richard.purdie |
| Version: | 1.5 | ||
| Target Milestone: | 1.5 M2 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| URL: | http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=8f5991f7d3a5ceee63a022af19afd713dcf740c3 | ||
| Whiteboard: | 19 July 2013 - RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Yes (doc changes required) | |
|
Description
Richard Purdie
2013-06-20 12:17:41 UTC
We currently link to http://www.openembedded.org/index.php?title=Required_software, which is a required software page for OpenEmbedded. That page specifically mentions python 2.6.x and 2.7.x as required. Git and Tar, however, are just listed as tools to download and upack, respectively, source code files. Are the version requirements noted in this bug outside of OpenEmbedded? Also, in the YP Quick Start at this section - http://www.yoctoproject.org/docs/1.5/yocto-project-qs/yocto-project-qs.html#the-linux-distro - we give some general system requirements regarding the distro. Do these general suggestions still hold true? PROPOSED DOC SOLUTION: For this bug, I will put in a note in this section specifically calling out the Git, Tar, and Python requirements needed on the development system in order to use YP. We currently link to the "Supported Linux Distributions" section in the YP reference manual. I will add the required Git, Tar, and Python versioning there as well. I am going to add a new sub-section to "System Requirements" (Section 1.3 of the YP Reference Manual). This section will specifically address the need for the right versions of Git, Tar, and Python and what the user can do if they have a system that cannot (for some reason) use those versions. (In reply to comment #1) > We currently link to > http://www.openembedded.org/index.php?title=Required_software, which is a > required software page for OpenEmbedded. That page specifically mentions > python 2.6.x and 2.7.x as required. Git and Tar, however, are just listed > as tools to download and upack, respectively, source code files. Are the > version requirements noted in this bug outside of OpenEmbedded? No, the requirements for OE have changed. > Also, in the YP Quick Start at this section - > http://www.yoctoproject.org/docs/1.5/yocto-project-qs/yocto-project-qs. > html#the-linux-distro - we give some general system requirements regarding > the distro. Do these general suggestions still hold true? On the most part, yes. Some N-1 distros may need the tarball to work, we still do support them, just with the use of the tarball. > PROPOSED DOC SOLUTION: > For this bug, I will put in a note in this section specifically calling out > the Git, Tar, and Python requirements needed on the development system in > order to use YP. We currently link to the "Supported Linux Distributions" > section in the YP reference manual. I will add the required Git, Tar, and > Python versioning there as well. > > I am going to add a new sub-section to "System Requirements" (Section 1.3 of > the YP Reference Manual). This section will specifically address the need > for the right versions of Git, Tar, and Python and what the user can do if > they have a system that cannot (for some reason) use those versions. Sounds good to me. Location for nightlies: http://autobuilder.yoctoproject.org/pub/nightly/CURRENT/buildtools/ Location for releases will end up being: http://downloads.yoctoproject.org/releases/yocto/yocto-1.5/buildtools/ All changes are in for this bug. Created a new section in the ref-manual area at http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual#required-git-tar-and-python-versions that details how to build or load a pre-built tarball of the build tools if the user's system does not meet certain Git, tar, or Python versioning requirements. A second area affected is in the Quick Start at http://www.yoctoproject.org/docs/1.5/yocto-project-qs/yocto-project-qs.html#the-linux-distro. I added a bit about basic versioning requirements here for the user and referenced them off to the ref-manual section for full details. The final piece here for this entry is the inclusion of the URL provided by Beth that will hold the pre-built buildtools tarball once YP 1.5 is released. Until the release happens, the link in this development version of the ref-manual, however, will not resolve. I marked the bug as IN PROGRESS REVIEW as it should be looked by someone. BTW - Richard Purdie did look at the new section in the ref-manual before leaving for a long time off and approved that. I will let this stand for a while and if I don't hear anything back in a reasonable time, I will mark it RESOLVED. Scott This has been reviewed and the changes are in master at http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#required-git-tar-and-python-versions. This particular fix also affected text in the QS at http://www.yoctoproject.org/docs/1.5/yocto-project-qs/yocto-project-qs.html#required-git-tar-and-python-versions. I have marked it as RESOLVED as this is the only feedback I got in 11 days. Scott Switching to verified |