[Scons-dev] Problem using doc toolchain?

William Blevins wblevins001 at gmail.com
Sat Aug 1 00:44:53 EDT 2015 

Bill,

I went and reread some of
https://bitbucket.org/scons/scons/wiki/DeveloperGuide/Documentation and I
think I might know why I was having issues.  I'm not sure if it clicked
that the doc generators used SCons under the hood, so I *might* have been
trying to generate the docs under a dirty working directory; I will
double-check that it seems to work under the CrossLanguage head.  When I
updated to newest tip, I was able to generate everything mostly identical
to Bill's last regenerate, but I do have a lot of deltas that look like my
generator is adding ctrl characters of some kind.  Any thoughts?

diff -r fe3772bb5a38 doc/generated/examples/EnumVariable_map_1.xml
> --- a/doc/generated/examples/EnumVariable_map_1.xml     Fri Jul 31
> 20:40:53 2015 -0700
> +++ b/doc/generated/examples/EnumVariable_map_1.xml     Tue Jun 30
> 02:22:12 2015 -0400
> @@ -1,4 +1,4 @@
>  <?xml version="1.0" encoding="UTF-8"?>
>  <screen 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">%
> <userinput>scons -Q COLOR=navy foo.o</userinput>
> -cc -o foo.o -c -DCOLOR="blue" foo.c
> +ESC[?1034hcc -o foo.o -c -DCOLOR="blue" foo.c
>  </screen>
> diff -r fe3772bb5a38 doc/generated/examples/addmethod_ex1_1.xml
> --- a/doc/generated/examples/addmethod_ex1_1.xml        Fri Jul 31
> 20:40:53 2015 -0700
> +++ b/doc/generated/examples/addmethod_ex1_1.xml        Tue Jun 30
> 02:22:12 2015 -0400
> @@ -1,6 +1,6 @@
>  <?xml version="1.0" encoding="UTF-8"?>
>  <screen 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">%
> <userinput>scons -Q /</userinput>
> -cc -o hello.o -c hello.c
> +ESC[?1034hcc -o hello.o -c hello.c
>  cc -o hello hello.o
>  Install file: "hello" as "/usr/bin/hello"
>  Install file: "hello" as "install/bin/hello"
>

Do I need to change my default encoding maybe?

V/R,
William


On Fri, Jul 31, 2015 at 5:42 PM, Bill Deegan <bill at baddogconsulting.com>
wrote:

> William,
>
> The windows portion is unrelated to the docs.
> It's only about building the windows install packages.
> All three doc scripts listed seem to produce the proper files once I built
> libxml2 and libxslt from scratch.
>
> (Also I think they worked fine with system installed python on ubuntu
> 14.04, but I didn't want to use that because missing windows installer
> stubs)
>
> -Bill
>
> On Fri, Jul 31, 2015 at 2:39 PM, William Blevins <wblevins001 at gmail.com>
> wrote:
>
>> No after I install python-lxslt it was obvious that the scripts switched
>> from lxml to lxml2 because the performance of the first two passes were
>> like night and day.
>>
>> On Fri, Jul 31, 2015 at 5:37 PM, Bill Deegan <bill at baddogconsulting.com>
>> wrote:
>>
>>> William,
>>>
>>> You're on centos?
>>> Do you have both python modules for libxml2 and libxslt installed? If so
>>> it shouldn't use lxml at all right?
>>> I found if it was using lxml the output wasn't correct.
>>>
>>> -Bill
>>>
>>> On Fri, Jul 31, 2015 at 2:34 PM, William Blevins <wblevins001 at gmail.com>
>>> wrote:
>>>
>>>> Bill,
>>>>
>>>> Did "docs-create-example-outputs.py" work for you?  Even using lxml2
>>>> mine was failing for maybe its related to the windows portion you are
>>>> talking about?
>>>>
>>>> V/R,
>>>> William
>>>>
>>>> On Fri, Jul 31, 2015 at 5:32 PM, William Blevins <wblevins001 at gmail.com
>>>> > wrote:
>>>>
>>>>> Can you add that information to
>>>>> https://bitbucket.org/scons/scons/wiki/DeveloperGuide/Documentation ?
>>>>>
>>>>> V/R,
>>>>> William
>>>>>
>>>>> On Fri, Jul 31, 2015 at 4:40 PM, Bill Deegan <
>>>>> bill at baddogconsulting.com> wrote:
>>>>>
>>>>>> O.k. Good.
>>>>>> It looks like the source of the bogus XML's was using lxml and not
>>>>>> using libxml2/libxslt.
>>>>>> Perhaps we should remove that as an option?
>>>>>> (even if only until someone is able to figure out why it's generating
>>>>>> bad output?)
>>>>>>
>>>>>> Here's my blog post on building this all from scratch on ubuntu.
>>>>>>
>>>>>>
>>>>>> http://baddogconsulting.com/building-python-with-libxml2-and-libxslt-on-ubuntu-1404-from-source.html
>>>>>>
>>>>>> (Need for scratch was driven by the fact that debian and there for
>>>>>> ubuntu strip the windows installer stubs from their python distributions)
>>>>>> -Bill
>>>>>>
>>>>>> On Fri, Jul 31, 2015 at 11:44 AM, Gary Oberbrunner <
>>>>>> garyo at oberbrunner.com> wrote:
>>>>>>
>>>>>>> All those look OK to me, Bill -- hmm, good thing I don't use swear
>>>>>>> words in my scons source dir names!  I wasn't expecting to see those in the
>>>>>>> doc! :-)
>>>>>>> There's no tool to check; you have to review by hand.  Usually the
>>>>>>> diffs are short like this.
>>>>>>>
>>>>>>> On Fri, Jul 31, 2015 at 1:30 PM, Bill Deegan <
>>>>>>> bill at baddogconsulting.com> wrote:
>>>>>>>
>>>>>>>> Did a clean python, libxml2-2.9.2, libxslt-1.28 from source (ran
>>>>>>>> into an issue with libpython.so from system python causing core dump with
>>>>>>>> got me stuck for a while because the error you get until you dig into it
>>>>>>>> just indicates that expat was not built with your python.. blog posting to
>>>>>>>> follow on that fun).
>>>>>>>>
>>>>>>>> Once I sorted expat issue, and run
>>>>>>>> /home/bdbaddog/tools/python-2.7.10/bin/python
>>>>>>>> bin/docs-update-generated.py
>>>>>>>> /home/bdbaddog/tools/python-2.7.10/bin/python bin/docs-validate.py
>>>>>>>> /home/bdbaddog/tools/python-2.7.10/bin/python
>>>>>>>> bin/docs-create-example-outputs.py
>>>>>>>>
>>>>>>>> I get only the following diffs:
>>>>>>>> M doc/generated/examples/caching_ex-random_1.xml
>>>>>>>>    http://pastebin.com/UwE75eTY
>>>>>>>> M doc/generated/examples/troubleshoot_explain1_3.xml
>>>>>>>>   http://pastebin.com/3n2f3e4y
>>>>>>>> M doc/generated/variables.gen
>>>>>>>>   http://pastebin.com/UnhexDVR
>>>>>>>> M doc/generated/variables.mod
>>>>>>>>    http://pastebin.com/E1nXYupB
>>>>>>>>
>>>>>>>> Are these all valid?
>>>>>>>> Is there an easy way to check them (aka a tool?)
>>>>>>>>
>>>>>>>> -Bill
>>>>>>>>
>>>>>>>>
>>>>>>>> On Fri, Jul 31, 2015 at 6:11 AM, William Blevins <
>>>>>>>> wblevins001 at gmail.com> wrote:
>>>>>>>>
>>>>>>>>> Dirk,
>>>>>>>>>
>>>>>>>>> I had lxslt installed but not python-lxslt.  Once that was
>>>>>>>>> installed it was obvious that it switched from lxml to lxml2 usage.  I
>>>>>>>>> still got another error.
>>>>>>>>> On Jul 31, 2015 3:18 AM, "Dirk Bächle" <tshortik at gmx.de> wrote:
>>>>>>>>>
>>>>>>>>>> Bill,
>>>>>>>>>>
>>>>>>>>>> On 30.07.2015 17:36, Bill Deegan wrote:
>>>>>>>>>>
>>>>>>>>>>>  From the code I've looked at if you have libxml2 & libxslt that
>>>>>>>>>>> is preferred, and then if not it will use lxml.
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>> your assumption is correct, this is done because libxml2 is
>>>>>>>>>> faster in general.
>>>>>>>>>>
>>>>>>>>>> It seems that libxml2 and pure lxml have different behaviour
>>>>>>>>>> regarding "normalizing namespaces" and that's where the diff comes from.
>>>>>>>>>> This makes at least the validation in the SernaFree XML editor choke for
>>>>>>>>>> the lxml output...:(
>>>>>>>>>>
>>>>>>>>>> I'm investigating this a little further and will try to find a
>>>>>>>>>> way around this. I'd really like to have the (almost) same output for both
>>>>>>>>>> XML toolchains, such that it gets accepted by most XML editors out there.
>>>>>>>>>>
>>>>>>>>>> @William: You said that after installing an additional package
>>>>>>>>>> the processing got faster and correct? My guess would be that you now have
>>>>>>>>>> a lxml distro/package that relies on libxml2 under the hood. This makes the
>>>>>>>>>> error go away of course...
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> I'll keep you posted, 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
>>>>>>>>
>>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> --
>>>>>>> Gary
>>>>>>>
>>>>>>> _______________________________________________
>>>>>>> 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
>>>
>>>
>>
>> _______________________________________________
>> 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/20150801/7995155e/attachment-0001.html>

More information about the Scons-dev mailing list