<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>13553</bug_id>
          
          <creation_ts>2019-09-25 18:38:42 +0000</creation_ts>
          <short_desc>Mega-manual fails to build (but other manuals do build)</short_desc>
          <delta_ts>2020-04-16 06:54:17 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Mega Manual</product>
          <component>mega-manual</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard>12 December 2019: IN PROGRESS REVIEW</status_whiteboard>
          <keywords></keywords>
          <priority>Undecided</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>3.1</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Kevin Cribbs">kec201909</reporter>
          <assigned_to name="akuster">akuster808</assigned_to>
          <cc>akuster808</cc>
    
    <cc>akuster</cc>
    
    <cc>richard.purdie</cc>
    
    <cc>srifenbark</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>Yes (doc changes required)</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>85070</commentid>
    <comment_count>0</comment_count>
    <who name="Kevin Cribbs">kec201909</who>
    <bug_when>2019-09-25 18:38:42 +0000</bug_when>
    <thetext>Unless I make the changes shown below, mega-manual doesn&apos;t build. The problem might not be noticed when building in a shallow directory hierarchy. This was confirmed in a very recent poky 81f9e815d36848761a9dfa94b00ad998bb39a4a6.


diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml
index b66b933..c2038de 100644
--- a/documentation/mega-manual/mega-manual.xml
+++ b/documentation/mega-manual/mega-manual.xml
@@ -332,22 +332,22 @@
     &lt;/para&gt;
 
     &lt;xi:include
-        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../../bitbake/doc/bitbake-user-manual/bitbak
+        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../bitbake/doc/bitbake-user-manual/bitbake-u
 
     &lt;xi:include
-        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../../bitbake/doc/bitbake-user-manual/bitbak
+        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../bitbake/doc/bitbake-user-manual/bitbake-u
 
     &lt;xi:include
-        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../../bitbake/doc/bitbake-user-manual/bitbak
+        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../bitbake/doc/bitbake-user-manual/bitbake-u
 
     &lt;xi:include
-        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../../bitbake/doc/bitbake-user-manual/bitbak
+        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../bitbake/doc/bitbake-user-manual/bitbake-u
 
     &lt;xi:include
-        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../../bitbake/doc/bitbake-user-manual/bitbak
+        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../bitbake/doc/bitbake-user-manual/bitbake-u
 
     &lt;xi:include
-        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../../bitbake/doc/bitbake-user-manual/bitbak
+        xmlns:xi=&quot;http://www.w3.org/2003/XInclude&quot; href=&quot;../../bitbake/doc/bitbake-user-manual/bitbake-u
 
 &lt;/book&gt;</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85094</commentid>
    <comment_count>1</comment_count>
    <who name="Richard Purdie">richard.purdie</who>
    <bug_when>2019-09-26 14:57:50 +0000</bug_when>
    <thetext>Can you confirm you were using poky to do this? I think our tech writer who usually runs this is probably using separate checkouts of the bitbake and yocto-docs repos which would explain the difference in behavior.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85134</commentid>
    <comment_count>2</comment_count>
    <who name="Kevin Cribbs">kec201909</who>
    <bug_when>2019-10-01 13:45:55 +0000</bug_when>
    <thetext>I used poky 81f9e815d36848761a9dfa94b00ad998bb39a4a6 when I confirmed this problem remains.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85155</commentid>
    <comment_count>3</comment_count>
    <who name="Armin Kuster">akuster</who>
    <bug_when>2019-10-02 20:10:43 +0000</bug_when>
    <thetext>(In reply to comment #2)
&gt; I used poky 81f9e815d36848761a9dfa94b00ad998bb39a4a6 when I confirmed this
&gt; problem remains.

ok. that is in master (2.8_M2), not a stable branch

git branch --contains 81f9e815d36848761a9dfa94b00ad998bb39a4a6
  master</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85284</commentid>
    <comment_count>4</comment_count>
    <who name="Kevin Cribbs">kec201909</who>
    <bug_when>2019-10-10 11:03:23 +0000</bug_when>
    <thetext>(In reply to comment #3)
&gt; (In reply to comment #2)
&gt; &gt; I used poky 81f9e815d36848761a9dfa94b00ad998bb39a4a6 when I confirmed this
&gt; &gt; problem remains.
&gt; 
&gt; ok. that is in master (2.8_M2), not a stable branch
&gt; 
&gt; git branch --contains 81f9e815d36848761a9dfa94b00ad998bb39a4a6
&gt;   master

Just in case any confusion remains ...

I found this problem while working with poky 2.7.1.

I tried the &quot;very recent poky 81f9e815d36848761a9dfa94b00ad998bb39a4a6&quot; in an attempt to avoid creating a bug report for something that was already fixed.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85300</commentid>
    <comment_count>5</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2019-10-10 14:52:57 +0000</bug_when>
    <thetext>Hi, 

I don&apos;t quite understand why this is happening.  When the mega-manual builds, it includes the BitBake manual&apos;s HTML file from a separately cloned bitbake directory. 

I don&apos;t checkout by hash much.  So, are you saying if you clone poky using 81f9e815d36848761a9dfa94b00ad998bb39a4a6, the mega-manual.xml file is corrupted?

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85457</commentid>
    <comment_count>6</comment_count>
    <who name="Kevin Cribbs">kec201909</who>
    <bug_when>2019-10-28 14:44:57 +0000</bug_when>
    <thetext>I still see the error described in the 2019-09-25 18:38:42 report when I do the following on a Linux Mint 19 PC:

After git cloning and checking out the current Warrior branch (commit: 4ada58f74c9bb5ab2fd4ef7a0c6ee4219b579d4b) ...

cd /tmp/poky_warrior_2.7.2_prerelease
. oe-init-build-env
cd ../documentation
make DOC=mega-manual html
 
******** Building mega-manual
 
cd mega-manual; xsltproc --stringparam html.stylesheet mega-style.css --stringparam  chapter.autolabel 1 --stringparam  section.autolabel 1 --stringparam  section.label.includes.component.label 1 --xinclude -o mega-manual.html mega-manual-customization.xsl mega-manual.xml; cd ..
warning: failed to load external entity &quot;../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml&quot;
mega-manual.xml:340: element include: XInclude error : could not load ../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml, and no fallback was found
warning: failed to load external entity &quot;../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml&quot;
mega-manual.xml:343: element include: XInclude error : could not load ../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml, and no fallback was found
warning: failed to load external entity &quot;../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml&quot;
mega-manual.xml:346: element include: XInclude error : could not load ../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml, and no fallback was found
warning: failed to load external entity &quot;../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml&quot;
mega-manual.xml:349: element include: XInclude error : could not load ../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml, and no fallback was found
warning: failed to load external entity &quot;../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml&quot;
mega-manual.xml:352: element include: XInclude error : could not load ../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml, and no fallback was found
warning: failed to load external entity &quot;../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml&quot;
mega-manual.xml:355: element include: XInclude error : could not load ../../../bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml, and no fallback was found
 
******** Using mega-manual.sed to process external links
 
cd mega-manual; sed -f ../tools/mega-manual.sed &lt; mega-manual.html &gt; mega-output.html; cd ..
/bin/sh: mega-manual.html: No such file or directory
 
******** Cleaning up transient file mega-output.html
 
cd mega-manual; rm mega-manual.html; mv mega-output.html mega-manual.html; cd ..
rm: cannot remove &apos;mega-manual.html&apos;: No such file or directory
mv: cannot stat &apos;mega-output.html&apos;: No such file or directory



Then edit mega-manual/mega-manual.xml to replace &quot;../../..&quot; with &quot;../..&quot;.

make DOC=mega-manual html
 
******** Building mega-manual
 
cd mega-manual; xsltproc --stringparam html.stylesheet mega-style.css --stringparam  chapter.autolabel 1 --stringparam  section.autolabel 1 --stringparam  section.label.includes.component.label 1 --xinclude -o mega-manual.html mega-manual-customization.xsl mega-manual.xml; cd ..
Note: namesp. cut : stripped namespace before processing           
            Yocto Project Mega-Manual
        
Note: namesp. cut : processing stripped document                   
            Yocto Project Mega-Manual
        
Attributed 36142 IDs for element, cleaned up 0
 
******** Using mega-manual.sed to process external links
 
cd mega-manual; sed -f ../tools/mega-manual.sed &lt; mega-manual.html &gt; mega-output.html; cd ..
 
******** Cleaning up transient file mega-output.html
 
cd mega-manual; rm mega-manual.html; mv mega-output.html mega-manual.html; cd ..



Using the current Warrior branch Creation of the mega-manual only works after replacing all ocurences of &quot;../../..&quot; with &quot;../..&quot; in &quot;mega-manual/mega-manual.xml&quot;. The problem also remains on the current master branch (commit: 3a751d5564fc6ee9aef225653cc7b8630fd25a35).</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85459</commentid>
    <comment_count>7</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2019-10-28 16:56:11 +0000</bug_when>
    <thetext>This could be because of where the bitbake directory is located.  In my build environment where I work on the manuals, I have the bitbake directory cloned at a top level directory - $HOME/bitbake.  When I build the BB manual, it looks up three levels to fine the HTML files for the BB manual.

When you clone poky, the bitbake manual repository is at the same level as the &quot;documentation&quot; folder, which makes the &quot;bitbake&quot; folder one level closer or lower.  So if a person builds the mega-manual from the poky repository locally it will not find the BB manuals by going ../../..   They would only be found using ../..  

I will likely have to change my production location for the bitbake manuals to follow the same hierarchy as if building the manual from the poky documentation folder.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85460</commentid>
    <comment_count>8</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2019-10-28 17:24:14 +0000</bug_when>
    <thetext>Kevin, 

I made the changes on my end.  My production environment now hierarchically matches the same structure as poky.  So, the HTML files for BitBake are found in the same level in my environment and in a poky-cloned environment.  I updated the mega-manual.xml file to use the ../.. search instead of the ../../../ search. 

You can&apos;t see the effects of this change and commit until the commit makes it into the poky repository.  Right now, the commit is pushed to the yocto-docs repo.  I don&apos;t control when changes get into the poky repository.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85751</commentid>
    <comment_count>9</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2019-12-06 00:56:56 +0000</bug_when>
    <thetext>Hi, 

Mega-manual builds correctly for &quot;warrior&quot;, &quot;zeus&quot;, and &quot;master&quot; Git development branches for all released versions of the manuals.  It works in my development environment.  It should work in a user&apos;s environment as long as the bitbake repository is in the &quot;poky&quot; folder, which it is.  

The updated files (mega-manual.xml) that correct the change had to use a &quot;../..&quot; file path rather than the &quot;../../..&quot; one that was causing the error.  The change will not work in a user environment until the commits that are responsible for the mega-manual.xml file are sucked into the poky upstream Git repository.  I believe Richard&apos;s automated scripts will deal with this.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85769</commentid>
    <comment_count>10</comment_count>
    <who name="Armin Kuster">akuster</who>
    <bug_when>2019-12-07 23:36:49 +0000</bug_when>
    <thetext>thanks Scott.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>85823</commentid>
    <comment_count>11</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2019-12-12 21:43:47 +0000</bug_when>
    <thetext>I am going to leave this in IN PROGRESS REVIEW for a while.  We will need to verify it works when all changes are merged into poky.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>87029</commentid>
    <comment_count>12</comment_count>
    <who name="akuster">akuster808</who>
    <bug_when>2020-04-16 06:54:17 +0000</bug_when>
    <thetext>I think this is fix. I have been building locally fine if I have bitbake in the correct location relative to the documentation build location.</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>