Bug 12669 - eclipse-plugin-neon/oxygen can't build yocto-docs master
Summary: eclipse-plugin-neon/oxygen can't build yocto-docs master
Status: RESOLVED FIXED
Alias: None
Product: Eclipse Plugin
Classification: Yocto Project Subprojects
Component: eclipse-plugin (show other bugs)
Version: 2.5
Hardware: All Multiple
: High normal
Target Milestone: 2.5 M4
Assignee: Scott Rifenbark
QA Contact: Toaster default assignee
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2018-04-10 00:21 UTC by Chin Huat Ang
Modified: 2018-05-10 07:46 UTC (History)
8 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: No (bug/feature does not impact docs)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Chin Huat Ang 2018-04-10 00:21:10 UTC
The following Eclipse plugin builds are currently failing on autobuilder:


https://autobuilder.yocto.io/builders/eclipse-plugin-neon/builds/912
https://autobuilder.yocto.io/builders/eclipse-plugin-oxygen/builds/431


Excerpt of build error:


******** Building eclipse help of yocto-project-qs
 
cd yocto-project-qs && \
	xsltproc  \
			--stringparam base.dir 'html/yocto-project-qs/' \
			-o eclipse/yocto-project-qs.html \
			yocto-project-qs-eclipse-customization.xsl yocto-project-qs.xml && \
	mv eclipse/toc.xml eclipse/yocto-project-qs-toc.xml && \
	cp -rf  eclipse/html/yocto-project-qs/ && \
	cd ..;
Note: namesp. cut : stripped namespace before processing           
            Yocto Project Quick Start
        
Note: namesp. cut : processing stripped document                   
            Yocto Project Quick Start
        
Element include in namespace 'http://www.w3.org/2003/XInclude' encountered in book, but no template matches.
cp: missing destination file operand after ‘eclipse/html/yocto-project-qs/’
Try 'cp --help' for more information.
Comment 1 Chin Huat Ang 2018-04-10 00:26:02 UTC
This appears to be caused by recent changes in yocto-docs which removed yocto-project-qs:

http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/documentation/Makefile?id=aadec4a70fa89e4dcd233c337d8971c8353ee26d

However it also appears that the following new documentation are being added:

  - brief-yoctoprojectqs
  - getting-started
  - concepts-manual
Comment 3 Scott Rifenbark 2018-04-12 11:06:49 UTC
Chin Huat, 

I have pushed the changes to the Makefile so that everything is settled down now regarding the addition and deletions and changing of manuals in the 2.5 YP manual set.  You should be able to use the Makefile from the master branch of yocto-docs now with no fear :)

Thanks,
Scott

https://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/tree/documentation/Makefile
Comment 4 Chin Huat Ang 2018-04-15 19:32:08 UTC
The earlier patch in comment 2 fixes eclipse build error as seen on autobuilder, while this patch adds new sumo release documentation:

https://lists.yoctoproject.org/pipermail/eclipse-yocto/2018-April/000142.html

The eclipse documentation plugin (org.yocto.doc.user) now includes all manuals as seen in the mega-manual.
Comment 5 Ross Burton 2018-04-17 03:21:26 UTC
Reassigning back to Chin Huat Ang as he's clearly on the case.  Recent changes to yocto-docs mean this isn't breaking every build, so the urgency has gone.
Comment 6 Tim Orling 2018-05-03 08:35:51 UTC
Chin Huat's patches [1][2] have been merged to oxygen-master and oxygen/sumo

Neon.3 was released March 23, 2017 we do not have resources to perform QA nor support it, so it will be a best effort only for sumo. The docs patches will also be applied to "neon-master" and "neon/sumo" will be created. FWIW docs patches will also be applied on to "master".

Need to verify that any docs changes since those patches were written are captured. On the bug triage call, RP mentioned that another manual had been dropped (concepts-manual? [3]).

[1] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2018-April/000141.html
[2] https://lists.yoctoproject.org/pipermail/eclipse-yocto/2018-April/000142.html
[3] http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?id=22c2de06baf96120cbc830540e818599ce0ac07b
Comment 7 Scott Rifenbark 2018-05-03 08:39:22 UTC
Tim, 

Correct - there is no longer a concepts-manual.  The information in that manual has been incorporated as a chapter of the overview-manual (https://www.yoctoproject.org/docs/2.5/overview-manual/overview-manual.html).

Scott
Comment 8 Tim Orling 2018-05-07 18:05:21 UTC
The patches from Comment #6 have been merged to neon-master [1] and master [2]. A neon/sumo branch has been created [3].

The currently built docs (after those patches) are:

DOCS="brief-yoctoprojectqs overview-manual dev-manual sdk-manual \
      bsp-guide kernel-dev profile-manual ref-manual"

I believe these are in-line with what is expected? Scott can you confirm?


[1] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto/commit/?h=neon-master&id=303e46a6848f1937d12541a7fd58e61aa1361225
[2] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto/commit/?id=83f3ac7eb0c43227485a8f0b8fc1fbaf6367c121
[3] http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-yocto/log/?h=neon/sumo
Comment 9 Tim Orling 2018-05-10 07:46:51 UTC
RP validated that the docs built look correct. Closing.