Bug 7089

Summary: URL field incomplete in section 4.2.2.1.3.1
Product: [Documentation] ADT Manual Reporter: Jan-Simon Moeller <dl9pf>
Component: SDKAssignee: Scott Rifenbark <srifenbark>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium CC: poky.doc.watcher, poky.watcher, richard.purdie, sgw, srifenbark
Version: 1.7   
Target Milestone: 1.7.2   
Hardware: x86   
OS: Multiple   
Whiteboard: 23 January 2015: IN PROGRESS REVIEW
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Jan-Simon Moeller 2014-12-18 16:43:31 UTC
4.2.2.1.3.1. Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site¶

To install the Eclipse Yocto Plug-in from the update site, follow these steps:

    Start up the Eclipse IDE.

    In Eclipse, select "Install New Software" from the "Help" menu.

    Click "Add..." in the "Work with:" area.

    Enter /releases/eclipse-plugin//kepler in the URL field and provide a 

         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This does not work as it expands to file:///releases/eclipse-plugin//kepler
Comment 2 Scott Rifenbark 2015-01-14 23:21:51 UTC
Hi, 

This error you found is a result of bug 7134, which has to do with broken ENTITY variable expansion.  Here is the string from the XML source file responsible for printing out that path in the HTML manual:

   &ECLIPSE_DL_PLUGIN_URL;/kepler

Note that the string has the ENTITY variable ECLIPSE_DL_PLUGIN_URL.  To further complicate matters, the ENTITY EXLIPSE_DL_PLUGIN_URL variable is further defined using two additional ENTITY variables:

   &YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;

So, in a nutshell, for the proper path to be expanded in the HTML version of the document, three ENTITY variables must resolve.  Proper expansion of the pathname would be as follows:

   http://downloads.yoctoproject.org/releases/eclipse-plugin/1.7/kepler

However, bug 7134 is not expanding these three ENTITY variables so you are seeing this:

   /releases/eclipse-plugin//kepler

So, for right now, the XML is correct in the manuals.  We are waiting on resolution of bug 7134 to make these issues go away. 

Stay tuned. 

Thanks, 
Scott
Comment 3 Scott Rifenbark 2015-01-23 21:59:13 UTC
Hi, 

The work-around for bug 7134 is in place now and I can generate manuals whose ENTITY variables properly resolve.  I have re-published the Yocto Project 1.7.1 and 1.7 versions of the manuals to the website with proper expansions.  To see the updated version for the section reported here, click on that link in Comment 1.

Thanks, 
Scott