[Scons-dev] Problem using doc toolchain?

Bill Deegan bill at baddogconsulting.com
Wed Jul 29 23:40:23 EDT 2015 

Dirk & all,

New output..

Here's the only changed files now:
hg status
M doc/generated/builders.gen
M doc/generated/functions.gen
M doc/generated/tools.gen
M doc/generated/variables.gen
M doc/generated/variables.mod

builders.gen:
https://pastebin.mozilla.org/8841027

hg diff doc/generated/builders.gen
https://pastebin.mozilla.org/8841028

I think these changes are ok? It looks like it switched the default
namespace to be scons instead of dbxsd and thus all scons's directives
don't need the namespace?


-Bill



On Wed, Jul 29, 2015 at 7:19 PM, William Blevins <wblevins001 at gmail.com>
wrote:

> I followed your work-flow though, and I got an error on step 3:
>
> $ python bin/docs-create-example-outputs.py
>> Checking whether all example names are unique...
>> OK
>> 0.48% (1/207) ex-NoCache
>> 0.97% (2/207) sideeffect_parallel
>> Traceback (most recent call last):
>>   File "bin/docs-create-example-outputs.py", line 19, in <module>
>>     SConsExamples.createAllExampleOutputs(os.path.join('doc','user'))
>>   File "/home/wblevins/BitBucket/scons_cl/bin/SConsExamples.py", line
>> 311, in createAllExampleOutputs
>>     create_scons_output(value)
>>   File "/home/wblevins/BitBucket/scons_cl/bin/SConsExamples.py", line
>> 881, in create_scons_output
>>     curchild.tail = content
>>   File "lxml.etree.pyx", line 938, in lxml.etree._Element.tail.__set__
>> (src/lxml/lxml.etree.c:41467)
>>   File "apihelpers.pxi", line 674, in lxml.etree._setTailText
>> (src/lxml/lxml.etree.c:19025)
>>   File "apihelpers.pxi", line 1335, in lxml.etree._utf8
>> (src/lxml/lxml.etree.c:24625)
>> ValueError: All strings must be XML compatible: Unicode or ASCII, no NULL
>> bytes or control characters
>>
>
>
> On Wed, Jul 29, 2015 at 10:12 PM, William Blevins <wblevins001 at gmail.com>
> wrote:
>
>> Bill,
>>
>>
>> On Wed, Jul 29, 2015 at 10:08 PM, William Blevins <wblevins001 at gmail.com>
>> wrote:
>>
>>> Bill,
>>>
>>> diff -r eba2d423ec1b doc/generated/builders.gen
>>>> --- a/doc/generated/builders.gen        Mon Jun 29 16:12:02 2015 -0400
>>>> +++ b/doc/generated/builders.gen        Mon Jun 29 19:38:34 2015 -0400
>>>> @@ -1,4 +1,4 @@
>>>> -<?xml version="1.0" encoding="UTF-8"?>
>>>> +<?xml version='1.0' encoding='UTF-8'?>
>>>>  <!DOCTYPE sconsdoc [
>>>>      <!ENTITY % scons SYSTEM "../scons.mod">
>>>>      %scons;
>>>> @@ -12,7 +12,7 @@
>>>>      %variables-mod;
>>>>  ]>
>>>>
>>>> -<variablelist xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="
>>>> http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="
>>>> http://www.scons.org/dbxsd/v1.0
>>>> http://www.scons.org/dbxsd/v1.0/scons.xsd">
>>>> +<variablelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
>>>> xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="
>>>> http://www.scons.org/dbxsd/v1.0
>>>> http://www.scons.org/dbxsd/v1.0/scons.xsd">
>>>>
>>>
>> This delta is the same for both of us.  Notice that its semantic
>> equivalent to what was already there.  The difference is that the xsi and
>> xmlns are specified in the opposite order, but that shouldn't matter.
>>
>>
>>>    <varlistentry id="b-CFile">
>>>>      <term>
>>>>        <function>CFile()</function>
>>>> @@ -20,18 +20,17 @@
>>>>      <term>
>>>>        <function>env.CFile()</function>
>>>>      </term>
>>>> -    <listitem>
>>>> -<para xmlns="http://www.scons.org/dbxsd/v1.0">
>>>> +    <listitem><para>
>>>>  Builds a C source file given a lex (<filename>.l</filename>)
>>>>  or yacc (<filename>.y</filename>) input file.
>>>>
>>>
>>> My diff looks almost exactly the same.
>>>
>>> Here is information for my Centos7 VM:
>>> libxml2-python-2.9.1-5.el7_1.2.x86_64
>>> python-lxml-3.2.1-4.el7.x86_64
>>> python-2.7.5-18.el7_1.1.x86_64
>>>
>>> I'm trying to list items mentioned here:
>>> https://bitbucket.org/scons/scons/wiki/DeveloperGuide/Documentation
>>>
>>> I don't have epydoc installed, but it seems to work without it.
>>>
>>> V/R,
>>> William
>>>
>>>
>>> On Wed, Jul 29, 2015 at 9:48 PM, Bill Deegan <bill at baddogconsulting.com>
>>> wrote:
>>>
>>>> William,
>>>>
>>>> On Wed, Jul 29, 2015 at 5:10 PM, William Blevins <wblevins001 at gmail.com
>>>> > wrote:
>>>>
>>>>> Bill,
>>>>>
>>>>> When I try to run the doc generator, I get something similar.  I am
>>>>> using the standard tools from Debian 8.
>>>>>
>>>>> Dirk,
>>>>>
>>>>> What platform and tool versions are you using?
>>>>>
>>>>
>>>> Ubuntu 14.04 + python 2.7.10 built from scratch + lxml
>>>> (Built from scratch as the python which ships with ubuntu drops the
>>>> windows installer stubs we use for our windows installers..)
>>>>
>>>> -Bill
>>>>
>>>>
>>>>
>>>>>
>>>>> V/R,
>>>>> William
>>>>>
>>>>> On Wed, Jul 29, 2015 at 6:47 PM, Dirk Bächle <tshortik at gmx.de> wrote:
>>>>>
>>>>>> Hi Bill,
>>>>>>
>>>>>> On 30.07.2015 00:30, Bill Deegan wrote:
>>>>>>
>>>>>>> Dirk (and anyone who understands the doc toolchain),
>>>>>>>
>>>>>>> I've run:
>>>>>>>
>>>>>>>     python bin/docs-update-generated.py
>>>>>>>     python bin/docs-validate.py
>>>>>>>     python bin/docs-create-example-outputs.py
>>>>>>>
>>>>>>> Per our release procedure working on getting 2.3.5 out.
>>>>>>>
>>>>>>> [...]
>>>>>>> Here's diff for functions.gen
>>>>>>> https://pastebin.mozilla.org/8841011
>>>>>>>
>>>>>>> (pretty much all the files have a diff, but I'm not sure they're an
>>>>>>> issue)
>>>>>>>
>>>>>>> Are any of these differences important?
>>>>>>>
>>>>>>>
>>>>>> I'll make this a "yes". The problem here is that the special XML tags
>>>>>> like "example_commands" don't exist in the standard "Docbook" namespace,
>>>>>> but only in the "http://www.scons.org/dbxsd/v1.0" namespace
>>>>>> referring to the extended "SCons Docbook". If you leave out these
>>>>>> specifications
>>>>>>
>>>>>>   xmlns="http://www.scons.org/dbxsd/v1.0"
>>>>>>
>>>>>> this may lead to errors during processing later. Even when you don't
>>>>>> see it at first while creating a PDF or EPUB directly, users might not be
>>>>>> able to directly edit the XML files with an editor like XmlMind or
>>>>>> SernaFree.
>>>>>>
>>>>>> Can you try and find out why your XML processing chain omits the
>>>>>> namespace definition within the single XML tags?
>>>>>>
>>>>>> Best regards,
>>>>>>
>>>>>> Dirk
>>>>>>
>>>>>> _______________________________________________
>>>>>> Scons-dev mailing list
>>>>>> Scons-dev at scons.org
>>>>>> https://pairlist2.pair.net/mailman/listinfo/scons-dev
>>>>>>
>>>>>
>>>>>
>>>>> _______________________________________________
>>>>> Scons-dev mailing list
>>>>> Scons-dev at scons.org
>>>>> https://pairlist2.pair.net/mailman/listinfo/scons-dev
>>>>>
>>>>>
>>>>
>>>> _______________________________________________
>>>> Scons-dev mailing list
>>>> Scons-dev at scons.org
>>>> https://pairlist2.pair.net/mailman/listinfo/scons-dev
>>>>
>>>>
>>>
>>
>
> _______________________________________________
> Scons-dev mailing list
> Scons-dev at scons.org
> https://pairlist2.pair.net/mailman/listinfo/scons-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://pairlist2.pair.net/pipermail/scons-dev/attachments/20150729/14caa23c/attachment.html>

More information about the Scons-dev mailing list