[PATCH] doc: Correct missing file warnings from files explicitly moved during build.

[Bill Spitzak]

It looks like the _8h files can be left as-is, I have posted two
alternative patches, the first keeps the _8h files and the second extracts
some documentation that was left in them.


On Thu, Jan 8, 2015 at 3:15 PM, Bill Spitzak <spitzak at gmail.com> wrote:

> Yea this was annoying.
>
> I think it may be possible to make the xslt converter just skip the stuff
> that is in these files. That would be a cleaner solution than trying to
> move them out of the way.
>
>
> On 01/08/2015 12:18 PM, Bryce Harrington wrote:
>
>> On Wed, Jan 07, 2015 at 06:44:06PM -0800, Jon A. Cruz wrote:
>>
>>> ---
>>>   doc/publican/Makefile.am | 6 ++++++
>>>   1 file changed, 6 insertions(+)
>>>
>>> diff --git a/doc/publican/Makefile.am b/doc/publican/Makefile.am
>>> index 278da12..1e3cde0 100644
>>> --- a/doc/publican/Makefile.am
>>> +++ b/doc/publican/Makefile.am
>>> @@ -91,13 +91,19 @@ $(builddir)/en-US/ProtocolInterfaces.xml:
>>> $(top_srcdir)/protocol/wayland.xml $(s
>>>
>>>   # * we don't want wayland-{server|client}_8h.xml to avoid duplicating
>>> output methods,
>>>   #   move it out of the way first.
>>> +# * create empty placeholders for moved files.
>>>   # * use doxygen's combine.xslt to merge the xml files into one single
>>> file
>>>   # * pipe that through the doxygen-to-publican stylesheet
>>>   # * move wayland-<foo>_8h.xml back to its original location
>>>   $(builddir)/en-US/%API.xml: $(doxydir)/xml/%/index.xml
>>> $(srcdir)/doxygen-to-publican.xsl | $(builddir)/en-US
>>> +       $(AM_V_at)rm -rf $(doxydir)/xml/$*/saved
>>>         $(AM_V_at)$(MKDIR_P) $(doxydir)/xml/$*/saved
>>>         $(AM_V_at)mv $(doxydir)/xml/$*/wayland-*_8h.xml \
>>>                 $(doxydir)/xml/$*/saved
>>> +       $(AM_V_at)for file in $(doxydir)/xml/$*/saved/*; \
>>> +               do TARG=$(doxydir)/xml/$*/`basename $${file}`; \
>>> +               echo "<?xml version='1.0' encoding='UTF-8'
>>> standalone='no'?><doxygen/>" > $${TARG}; \
>>> +               done
>>>         $(AM_V_GEN)$(XSLTPROC) $(doxydir)/xml/$*/combine.xslt \
>>>                 $(doxydir)/xml/$*/index.xml | \
>>>                 $(XSLTPROC) --stringparam which $* \
>>>
>>
>> The original warnings are:
>>
>>    GEN      en-US/ProtocolInterfaces.xml
>>    GEN      en-US/ClientAPI.xml
>> warning: failed to load external entity "../../doc/doxygen/xml/Client/
>> wayland-client_8h.xml"
>> warning: failed to load external entity "../../doc/doxygen/xml/Client/
>> wayland-util_8h.xml"
>>    GEN      en-US/ServerAPI.xml
>> warning: failed to load external entity "../../doc/doxygen/xml/Server/
>> wayland-server_8h.xml"
>> warning: failed to load external entity "../../doc/doxygen/xml/Server/
>> wayland-util_8h.xml"
>>    GEN      Wayland/en-US/html/css
>>    GEN      Wayland/en-US/html/css/brand.css
>>
>> But with this patch applied:
>>
>>    GEN      en-US/ProtocolInterfaces.xml
>>    GEN      en-US/ClientAPI.xml
>>    GEN      en-US/ServerAPI.xml
>>    GEN      Wayland/en-US/html/css
>>    GEN      Wayland/en-US/html/css/brand.css
>>
>> No other issues seem to crop up during build.  Looks good to me.
>>
>> Reviewed-by: Bryce Harrington <bryce at osg.samsung.com>
>> Tested-by: Bryce Harrington <bryce at osg.samsung.com>
>> _______________________________________________
>> wayland-devel mailing list
>> wayland-devel at lists.freedesktop.org
>> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
>>
>>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/wayland-devel/attachments/20150123/f768b4c4/attachment-0001.html>