Re: XML Parse error on Local Build

[David T. via gnucash-devel]

> On Dec 10, 2016, at 11:13 PM, Geert Janssens  
> wrote:
> 
> Op vrijdag 9 december 2016 18:52:00 CET schreef David T.:
>> Geert,
>> 
>> The output is long, and attached below. I have scanned it, but nothing jumps
>> out at me. The errors seem to start immediately after the docbook files
>> load, which is puzzling.
>> 
>> David
> 
> Hi David,
> 
> Odd indeed. At first sight this suggests something is wrong with your gnucash-
> guide.xml file.
> 
> In which directory are you running this ? Is that the directory which 
> contains 
> your clone of the gnucash-docs repository ?
> What is the output of "git status" in that directory
> And what does "git diff gnucash-guide.xml" report ?
> 
> Geert 
> 

Here are the results of those [origin is my github fork from the main gnucash 
repository, as recommended]:

DHT-Retina:C david$ git status
On branch bug-743671
Your branch is up-to-date with 'origin/bug-743671'.
nothing to commit, working directory clean
DHT-Retina:C david$ git diff gnucash-guide.xml
DHT-Retina:C david$ 
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[Geert Janssens]

Op vrijdag 9 december 2016 18:52:00 CET schreef David T.:
> > On Dec 9, 2016, at 5:44 PM, Geert Janssens 
> > wrote:
> > 
> > David,
> > 
> > Can you post the full output of xsltproc ?
> > 
> > In addition, to debug your issue, can you run xsltproc with an extra
> > option ? Below xsltproc commands should be on one line, my e-mail client
> > splits them up unfortunately...
> > 
> > xsltproc --load-trace -o output_html/ ../../xsl/general-customization.xsl
> > gnucash-guide.xml
> > 
> > The output on the command line should list all files that have been opened
> > during the xsltproc run. That might help figure out if perhaps some files
> > are read multiple times or from another place than you are expecting.
> > 
> > 
> > Geert
> 
> Geert,
> 
> The output is long, and attached below. I have scanned it, but nothing jumps
> out at me. The errors seem to start immediately after the docbook files
> load, which is puzzling.
> 
> David

Hi David,

Odd indeed. At first sight this suggests something is wrong with your gnucash-
guide.xml file.

In which directory are you running this ? Is that the directory which contains 
your clone of the gnucash-docs repository ?
What is the output of "git status" in that directory
And what does "git diff gnucash-guide.xml" report ?

Geert 

___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[Colin Law]

On 10 December 2016 at 13:33, Geert Janssens  wrote:
> ...
> I agree the complete details of autogen/configure/make are fairly complex. I
> don't even understand all of it myself. The complexity stems from the design
> idea to create a build system that's generic enough to build all kinds of
> objects (applications, libraries, documentation, websites, whatever) on as
> many different platforms as possible. Luckily we don't need all of this
> complexity for our purposes.
>
> Let me try to explain this top to bottom. The command we're ultimately
> interested in is 'make'. This command follows recipes to convert some source
> files into some end object(s). For gnucash this is a bunch of c and guile
> sources which are transformed into the gnucash application (which itself is
> composed of an executable and lots of libraries). There are lots of details
> I'm glossing over here, focusing mostly on the principles.
>
> For our docs plain make (without explicit target that is) does nothing,
> because the xml files are both the source and the target which yelp needs to
> display the docs.
>
> However aside from the main target one can also define alternative targets. A
> few spring to mind for the docs: html, pdf, mobi, epub, install. So one could
> run
> make pdf
> and make will search a recipe to build one or more pdf files, depending on
> which directory you execute the command in.
>
> 'install' is a special recipe that is intended to put whatever make built as
> primary target (the xml files in case of the docs, which are the same as the
> source xml files) in a special location where a typical unix system expects
> these files. For example, executables typically should be installed in
> /usr/bin on linux. This location can be overridden. I'll get back to this
> later.
>
> Where does make find all these recipes ?
> make looks for a file called Makefile in the current directory. Makefile holds
> the recipes and other configuration items. Unfortunately this file is very
> complex in itself because - as I said earlier - the build system is designed
> to work in very different environments.
> For example the location of all the tools needed to create targets from the
> source files (like xsltproc) may be installed in different locations on
> different platforms, or even have a different name (like xsltproc.exe in a
> Windows environment). Or some commandline options for certain tools may not
> be available on all platforms or versions of the tool. Manually coping with
> all these variations will quickly result in a mess.
>
> So to cope with this a configuration step was added to the build process. This
> step runs a very complicated script called "configure" that will analyze your
> system and actually creates the Makefile files I described above. configure
> will lookup installation location for all tools used and can enable or disable
> certain recipes in the Makefiles based on its findings. "configure" can also
> take extra commandline options that can alter what it will include in the
> Makefiles. You can see these options by running configure --help. Most of them
> are not relevant for us, except for the few we invented ourselves like
> --with-mobi.
>
> "configure" doesn't take Makefile's as input. Instead it will read files
> called Makefile.in, which is a pseudo Makefile with lots or variables that
> still need final setting.
>
> Still, writing a configure script and Makefile.in files remains very
> cumbersome and lots of information in both files comes back all the time in
> different projects. So yet another step was added before in the build system.
> This step is meant to generate the configure script and the Makefile.in files
> based on another set of files: configure.ac and Makefile.am files.
> These files encode the essence of configure and the final Makefiles, but with
> everything removed that can be detected by a smart configuration script. Only
> the details that matter and are unique for each project are retained in these
> files.
> Generating configure and the various Makefile.in files involve a few steps,
> but they are always the same, regardless of the platform you run them on. For
> this reason they are combined together in a small script called autogen.sh.
> This script itself is the platform independent and is used to initiate the
> whole build system for a given project.
>
> And that's the general idea behind the autotools based build system. Again I
> glossed over a lot of details.
>
> As a rule of thumb, autogen.sh should be called the first time you want to
> initialize the build system and sometimes when changes are made in
> configure.ac or the Makefile.am files. Frequently those changes are
> autodetected though. Calling autogen.sh when it's not necessary doesn't doe
> harm either way. The only side effect is that the first next build may take
> longer.
>
> The same goes for "configure". It should generally be called right after
> autogen.sh for the same 

Re: XML Parse error on Local Build

[Geert Janssens]

Op vrijdag 9 december 2016 19:00:51 CET schreef Chris Good:
> > Message: 2
> > Date: Wed, 07 Dec 2016 20:36:30 +0100
> > From: Geert Janssens <geert.gnuc...@kobaltwit.be>
> > To: gnucash-devel@gnucash.org, "David T." <sunfis...@yahoo.com>
> > Subject: Re: XML Parse error on Local Build
> > Message-ID: <1942799.lyrszbb...@legolas.kobaltwit.lan>
> > Content-Type: text/plain; charset="us-ascii"
> > 
> > Op dinsdag 6 december 2016 17:05:37 CET schreef David T. via
> 
> gnucash-devel:
> > > Hi,
> > > 
> > > I am trying to finish a first pass at a new Glossary for the Guide. My
> > > changes are focused in a new file (gnc-glossary.xml) and in
> > > gnucash-guide.xml. In the latter, I have added two lines to
> > > incorporate the new file into the guide.
> > > 
> > > I have reached the point of running the commands:
> > > 
> > > xmllint --valid --noout gnucash-guide.xml xsltproc -o
> > > ../../../output_html/guide/ ../../xsl/general-customization.xsl
> > > gnucash-guide.xml
> > > 
> > > These are prescribed by the Wiki page.
> > 
> > A side note, more targeted at Chris who's done an excellent job so far to
> > keep the Documentation Update wiki page up to date:
> > I haven't fully read that page in a long time, so this never struck me
> > before:
> > 
> > I wonder why you explicitly explain to use xmllint and xsltproc ?
> > Both commands are incorporated in the makefile system for the
> > documentation.
> > 
> > So my typical flow (after a git clone/checkout/pull whatever) is
> > - in the gnucash-docs directory run "./autogen.sh"
> > - then make a build directory to keep the build documentation out of the
> > source tree for cleanliness. Let's call that directory "build" for this
> > example.
> > Typically this can be done using "mkdir build"
> > - Then from within the build directory call configure. Assuming build is a
> > 
> > direct
> > subdirectory of gnucash-docs, do
> > 
> >   cd build
> >   ../configure
> > 
> > - This will recreate the gnucash-docs directory structure under build. But
> > 
> > not
> > the files. Instead you will find a Makefile in most directories. From now
> 
> on
> 
> > you can choose at which level you wish to run commands. Either for all of
> > the
> > documentation, or only for the guide or only for one specific language of
> > the
> > guide. Just cd into the proper directory. For the options above these
> 
> would
> 
> > be
> > respectively: build, build/guide and build/guide/.
> > - The command to run xmllint is
> > make check
> > - The command to generate the html documentation is make html
> > 
> > Did you have a particular reason not to use these ? The documentation will
> > let you use these anyway in a later step  to "test on linux", so I figure
> > you
> > might as well just stick with them for the earlier steps as well. That way
> > there's only one set of commands to remember.
> > 
> > Regards,
> > 
> > Geert
> 
> Hi Geert,
> 
> I've always used the xmllint and xsltproc commands for several reasons.
> 1) That's what was in the wiki Documentation_Update_Instructions and until
> John Ralls mentioned recently that you could use the make commands instead I
> had no idea this was possible.
> 2) I didn't understand enough about what the autogen.sh, configure & make
> commands actually did. I did have a look but decided not to spend too much
> time on that as I had a workable system (without using a separate build
> system). Thanks for you explanations. I learn all the time.
> The instructions for creating a system where you could build gnucash-docs
> are spread all over the place, refer mostly building gnucash itself, and use
> different directory names (install, build, release, distrelease etc). I
> understand that we are free to name some directories whatever we like, but
> the lack of consistent guidance makes it hard to know exactly what the
> documentation is
> referring to.
> 
> BTW, What does autogen.sh do? Does it examine the system to determine if &
> where required software is installed and save that information for later use
> of configure?
> 
I agree the complete details of autogen/configure/make are fairly complex. I 
don't even understand all of it myself. The complexity stems from the design 
idea to create a build system that's generic enough to build all kinds of 
objects (applications, libraries, documentation, websites, 

Re: XML Parse error on Local Build

[David T. via gnucash-devel]

> On Dec 9, 2016, at 5:44 PM, Geert Janssens  wrote:
> 
> David,
> 
> Can you post the full output of xsltproc ?
> 
> In addition, to debug your issue, can you run xsltproc with an extra option ? 
> Below xsltproc commands should be on one line, my e-mail client splits them 
> up 
> unfortunately...
> 
> xsltproc --load-trace -o output_html/ ../../xsl/general-customization.xsl 
> gnucash-guide.xml
> 
> The output on the command line should list all files that have been opened 
> during the xsltproc run. That might help figure out if perhaps some files are 
> read multiple times or from another place than you are expecting.
> 
> 
> Geert

Geert, 

The output is long, and attached below. I have scanned it, but nothing jumps 
out at me. The errors seem to start immediately after the docbook files load, 
which is puzzling.

David

**
DHT-Retina:C david$ xsltproc --load-trace -o output_html/ 
../../xsl/general-customization.xsl gnucash-guide.xml 
Loaded URL="../../xsl/general-customization.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/chunk.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/docbook.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/VERSION" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/param.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/lib/lib.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/lib/dumpfragment.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/l10n.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/common.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/utility.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/labels.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/titles.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/subtitles.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/gentext.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/targets.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/olink.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/pi.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/autotoc.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/autoidx.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/entities.ent" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/lists.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/callout.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/verbatim.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/graphics.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/xref.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/formal.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/dtbl.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/table.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/table.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/htmltbl.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/sections.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/inline.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/entities.ent" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/footnote.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/html.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/info.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/keywords.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/division.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/toc.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/index.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/refentry.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/math.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/admon.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/component.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/biblio.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/biblio-iso690.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/glossary.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/entities.ent" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/block.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/task.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/qandaset.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/synop.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/titlepage.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/titlepage.templates.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/pi.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/ebnf.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/chunker.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/html-rtf.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/annotations.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/common/stripns.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/chunk-common.xsl" ID="(null)"
Loaded URL="../../xsl/1.75.2/html/chunk-code.xsl" ID="(null)"
Loaded URL="../../xsl/titlepage2.xsl" ID="(null)"
Loaded URL="../../xsl/chunk-common2.xsl" ID="(null)"
Loaded URL="../../xsl/parttitle.xsl" ID="(null)"
Loaded URL="../../xsl/navigation.xsl" ID="(null)"
Loaded URL="../../xsl/publisher.xsl" ID="(null)"
Loaded URL="../../xsl/revhistory.xsl" ID="(null)"
Loaded 

Re: XML Parse error on Local Build

[Geert Janssens]

Op vrijdag 9 december 2016 17:07:23 CET schreef David T.:
> > On Dec 9, 2016, at 1:00 PM, Chris Good  wrote:
> > 
> > Did you fix your build problem David?
> > 
> > I'd be interested in hearing what IDE's other people use for GnuCash
> > and/or
> > GnuCash documentation.
> > 
> > Regards,
> > Chris Good
> 
> Chris,
> 
> I still have my build issues.
> 
> I am bare bones, using a text editor to modify the XML documentation.
> 
> David

David,

Can you post the full output of xsltproc ?

In addition, to debug your issue, can you run xsltproc with an extra option ? 
Below xsltproc commands should be on one line, my e-mail client splits them up 
unfortunately...

xsltproc --load-trace -o output_html/ ../../xsl/general-customization.xsl 
gnucash-guide.xml

The output on the command line should list all files that have been opened 
during the xsltproc run. That might help figure out if perhaps some files are 
read multiple times or from another place than you are expecting.


Geert
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[David T. via gnucash-devel]

> On Dec 9, 2016, at 1:00 PM, Chris Good  wrote:
> 
> Did you fix your build problem David?
> 
> I'd be interested in hearing what IDE's other people use for GnuCash and/or
> GnuCash documentation.
> 
> Regards,
> Chris Good

Chris,

I still have my build issues.

I am bare bones, using a text editor to modify the XML documentation.

David
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

RE: XML Parse error on Local Build

[Chris Good]

> Message: 2
> Date: Wed, 07 Dec 2016 20:36:30 +0100
> From: Geert Janssens <geert.gnuc...@kobaltwit.be>
> To: gnucash-devel@gnucash.org, "David T." <sunfis...@yahoo.com>
> Subject: Re: XML Parse error on Local Build
> Message-ID: <1942799.lyrszbb...@legolas.kobaltwit.lan>
> Content-Type: text/plain; charset="us-ascii"
>
> Op dinsdag 6 december 2016 17:05:37 CET schreef David T. via
gnucash-devel:
> > Hi,
> >
> > I am trying to finish a first pass at a new Glossary for the Guide. My
> > changes are focused in a new file (gnc-glossary.xml) and in
> > gnucash-guide.xml. In the latter, I have added two lines to
> > incorporate the new file into the guide.
> >
> > I have reached the point of running the commands:
> >
> > xmllint --valid --noout gnucash-guide.xml xsltproc -o
> > ../../../output_html/guide/ ../../xsl/general-customization.xsl
> > gnucash-guide.xml
> >
> > These are prescribed by the Wiki page.
>
> A side note, more targeted at Chris who's done an excellent job so far to
> keep the Documentation Update wiki page up to date:
> I haven't fully read that page in a long time, so this never struck me 
> before:
>
> I wonder why you explicitly explain to use xmllint and xsltproc ?
> Both commands are incorporated in the makefile system for the
> documentation.
>
> So my typical flow (after a git clone/checkout/pull whatever) is
> - in the gnucash-docs directory run "./autogen.sh"
> - then make a build directory to keep the build documentation out of the
> source tree for cleanliness. Let's call that directory "build" for this 
> example.
> Typically this can be done using "mkdir build"
> - Then from within the build directory call configure. Assuming build is a

> direct
> subdirectory of gnucash-docs, do
>   cd build
>   ../configure
> - This will recreate the gnucash-docs directory structure under build. But

> not
> the files. Instead you will find a Makefile in most directories. From now
on
> you can choose at which level you wish to run commands. Either for all of 
> the
> documentation, or only for the guide or only for one specific language of 
> the
> guide. Just cd into the proper directory. For the options above these
would
> be
> respectively: build, build/guide and build/guide/.
> - The command to run xmllint is
> make check
> - The command to generate the html documentation is make html
>
> Did you have a particular reason not to use these ? The documentation will
> let you use these anyway in a later step  to "test on linux", so I figure 
> you
> might as well just stick with them for the earlier steps as well. That way
> there's only one set of commands to remember.
>
> Regards,
>
> Geert

Hi Geert,

I've always used the xmllint and xsltproc commands for several reasons.
1) That's what was in the wiki Documentation_Update_Instructions and until
John Ralls mentioned recently that you could use the make commands instead I
had no idea this was possible.
2) I didn't understand enough about what the autogen.sh, configure & make
commands actually did. I did have a look but decided not to spend too much
time on that as I had a workable system (without using a separate build
system). Thanks for you explanations. I learn all the time. 
The instructions for creating a system where you could build gnucash-docs
are spread all over the place, refer mostly building gnucash itself, and use
different directory names (install, build, release, distrelease etc). I
understand that we are free to name some directories whatever we like, but
the lack of consistent guidance makes it hard to know exactly what the
documentation is 
referring to.

BTW, What does autogen.sh do? Does it examine the system to determine if &
where required software is installed and save that information for later use
of configure?

3) I wanted to use an IDE, netbeans being what I am most familiar with. I
wanted to use the netbeans xml editor and integrated git/github support. I
haven't tried to use netbeans to do any of the making. Maybe that is
possible, but the GnuCash make system seems very easy to use.
I found that I could:
 a. Clone  gnucash-docs to ~/github/gnucash-docs
 b. Rename gnucash-docs to gnucash-docs-save (as a netbeans project must be
created in an empty folder)
 c. Create a netbeans project in ~/github/gnucash-docs
 d. copy/move all files and directories ((including hidden folders like
.git) in ~/github/gnucash-docs-save to ~/github/gnucash-docs and I would
have a working netbeans project with working git/github integration in the
repository directory.

4) Using a separate 'build' directory seemed as though it would cause
problems with my system and be more work. Should I edit the files in my

Re: XML Parse error on Local Build

[David T. via gnucash-devel]

> On Dec 8, 2016, at 1:00 AM, Geert Janssens  wrote:
> 
> Hi David,
> 
> To fix the reports chapter omission, just create a new commit on your current 
> PR. It's not strictly related but it's a rather trivial change so I don't see 
> the need for you to go through all the hoops of creating a separate branch 
> and 
> pull request. Have your commit message for this additional commit clearly 
> state it's fixing an omission to your previous work. You can mention the 
> other 
> bug number in there. Then everybody can follow what is going on.
> 
> In general, once a commit is integrated in the main repositories, you 
> shouldn't change them anymore. So your question of 'somehow adding it to my 
> previous commit' is a no-go, because that commit is already in the main 
> gnucash-docs repository.
> 
> While it's not needed at all in this case, the formal way would have been to 
> create a new branch from maint and make the change on that branch. If you 
> change the same file on two branches, this may indeed result in a merge 
> conflict later on, but only if the changes are near to each other in the 
> file. 
> "Near" usually means less than 4 lines apart. If they're further away, git 
> still knows how to perform the merge. As the changes in this case are easy to 
> understand for the more experienced developers, we would have been able to 
> resolve this conflict if the changes were too close together. In general this 
> becomes more difficult with the number of conflicts in one merge.
> 
> Regards,
> 
> Geert

Geert,

I’ve done as you advised, and it looks like it’s in the PR (commit 
695bd264903428845b7b6ec2b200b0e1b3943d32).

Cheers,
David
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[Geert Janssens]

[[Hmm, I noticed this got off-list accidentally. Resending to list as well.]]

Op donderdag 8 december 2016 00:39:23 CET schreef David T.:
> Geert,
> 
> Thanks for noticing the errors.
> 
> As for makefile.am, it seems I missed that with the Reports chapter I added
> a little while back, too. I will see about fixing that, too.
> 
> With regard to the earlier makefile.am omission, how should I handle that?
> Should I do a new branch? Branching from where? maint? my bug-specific
> branch? Somehow add it to my previous commit? And if I do a new branch now,
> how will I handle the fact that both the glossary change and the reports
> change are affecting the one file? I am aware that versioning addresses
> this, but my grasp of these tools is rudimentary at best, and up to now I
> have made changes in different files in the repository purposefully so as
> to avoid being presented with this deep existential question.
> 
> As for the xsltproc thing, as I said, I suspect some local oddity that is
> causing the errors to fly. Maybe someday I will figure it out.
> 
> David

Hi David,

To fix the reports chapter omission, just create a new commit on your current 
PR. It's not strictly related but it's a rather trivial change so I don't see 
the need for you to go through all the hoops of creating a separate branch and 
pull request. Have your commit message for this additional commit clearly 
state it's fixing an omission to your previous work. You can mention the other 
bug number in there. Then everybody can follow what is going on.

In general, once a commit is integrated in the main repositories, you 
shouldn't change them anymore. So your question of 'somehow adding it to my 
previous commit' is a no-go, because that commit is already in the main 
gnucash-docs repository.

While it's not needed at all in this case, the formal way would have been to 
create a new branch from maint and make the change on that branch. If you 
change the same file on two branches, this may indeed result in a merge 
conflict later on, but only if the changes are near to each other in the file. 
"Near" usually means less than 4 lines apart. If they're further away, git 
still knows how to perform the merge. As the changes in this case are easy to 
understand for the more experienced developers, we would have been able to 
resolve this conflict if the changes were too close together. In general this 
becomes more difficult with the number of conflicts in one merge.

Regards,

Geert
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[Geert Janssens]

Op dinsdag 6 december 2016 17:05:37 CET schreef David T. via gnucash-devel:
> Hi,
> 
> I am trying to finish a first pass at a new Glossary for the Guide. My
> changes are focused in a new file (gnc-glossary.xml) and in
> gnucash-guide.xml. In the latter, I have added two lines to incorporate the
> new file into the guide.
> 
> I have reached the point of running the commands:
> 
> xmllint --valid --noout gnucash-guide.xml
> xsltproc -o ../../../output_html/guide/ ../../xsl/general-customization.xsl
> gnucash-guide.xml
> 
> These are prescribed by the Wiki page. 

A side note, more targeted at Chris who's done an excellent job so far to keep 
the Documentation Update wiki page up to date:
I haven't fully read that page in a long time, so this never struck me before:

I wonder why you explicitly explain to use xmllint and xsltproc ?
Both commands are incorporated in the makefile system for the documentation.

So my typical flow (after a git clone/checkout/pull whatever) is
- in the gnucash-docs directory run "./autogen.sh"
- then make a build directory to keep the build documentation out of the 
source tree for cleanliness. Let's call that directory "build" for this 
example. Typically this can be done using
"mkdir build"
- Then from within the build directory call configure. Assuming build is a 
direct subdirectory of gnucash-docs, do
  cd build
  ../configure
- This will recreate the gnucash-docs directory structure under build. But not 
the files. Instead you will find a Makefile in most directories. From now on 
you can choose at which level you wish to run commands. Either for all of the 
documentation, or only for the guide or only for one specific language of the 
guide. Just cd into the proper directory. For the options above these would be 
respectively: build, build/guide and build/guide/.
- The command to run xmllint is
make check
- The command to generate the html documentation is
make html

Did you have a particular reason not to use these ? The documentation will let 
you use these anyway in a later step  to "test on linux", so I figure you 
might as well just stick with them for the earlier steps as well. That way 
there's only one set of commands to remember.

Regards,

Geert
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[Geert Janssens]

Op woensdag 7 december 2016 16:32:54 CET schreef Chris Good:
> From: David T. [mailto:sunfis...@yahoo.com]
> Sent: Wednesday, 7 December 2016 4:04 PM
> To: Chris Good <chris.g...@ozemail.com.au>
> Cc: gnucash-devel@gnucash.org
> Subject: Re: XML Parse error on Local Build
> 
> 
> 
> 
> 
> On Dec 7, 2016, at 9:39 AM, Chris Good <chris.g...@ozemail.com.au
> <mailto:chris.g...@ozemail.com.au> > wrote:
> 
> 
> 
> 
> 
> -Original Message-
> From: David T. [mailto:sunfis...@yahoo.com]
> Sent: Wednesday, 7 December 2016 2:42 PM
> To: Chris Good <chris.g...@ozemail.com.au <mailto:chris.g...@ozemail.com.au>
> > Cc: gnucash-devel@gnucash.org <mailto:gnucash-devel@gnucash.org> ;
> frank.h.ellenber...@gmail.com <mailto:frank.h.ellenber...@gmail.com>
> Subject: Re: XML Parse error on Local Build
> 
> Chris,
> 
> Thanks for the response. Initially, I thought that I had accidentally
> inserted duplicate entries in the glossary; however, the errors persisted
> even after I changed them all in my file. Further examination of the long
> chain of errors shows me that they encompass all areas of the
> documentation—including ones that I did not touch at all.
> 
> I suspect that there is some simple aspect to the process that I am missing,
> and somewhere on my system is a second instance that the command finds and
> barks about. Over and over and over again. But like the young wizards in an
> adventure tale, I don’t fully understand the content of the incantations I
> invoke before I make them, and I think I need a Dumbledore to explain to me
> the errors of my ways…
> 
> Thanks,
> David
> 
> 
> Hi David,
> 
> Are you sure you're running 2 separate commands:
>  xmllint --valid --noout gnucash-guide.xml
> and
> xsltproc -o ../../../output_html/guide/ ../../xsl/general-customization.xsl
> gnucash- guide.xml
> 
> They seem to have been joined together (maybe just by mail).
> 
> Maybe doing from the guide/C directory:
> grep -n invest-split1 *.xml
> will help identify the problem (-n means print the line no's in the file(s)
> where the string is found). Id 'invest-split1' must only be defined once in
> all xml files in the directory but it can be linked to multiple times like:
> 
> 
> Regards, Chris Good
> 
> 
> 
> Yes, definitely different commands.
> 
> 
> 
> Grep turns up only one entry for the particular example I included.
> 
> 
> 
> The reason I suspect I am missing a broad step on my system is that there
> are 596 different instances of this same basic error every time I run the
> command, so it’s not a matter of a couple of typos in my changes. There’s
> something I need to do differently to remove these (what I believe to be
> spurious) errors.
> 
> 
> 
> Another possibility is that in modifying gnucash-guide.xml to include the
> new glossary file, I somehow messed that file up so that the compile
> process is revisiting some of the files. That would explain the
> duplication. However, I literally added 2 lines to gnucash-guide.xml,
> adding:
> 
> 
> 
> 
> 
> 
> 
> 
> 
> to the list of files at line 34, and:
> 
> 
> 
> 
> 
> 
> 
> to the main  definition at line 519. From my understanding, this
> shouldn’t cause the multitude of errors.
> 
> 
> 
> Cheers,
> 
> David
> 
> 
> 
> Hi David,
> 
> 
> 
> As you’re adding a new file, I think you also need to add it to Makefile.in
> and Makefile.am. Just follow what you see in those.
> 
> 
> 
> From looking at one of the prior commits which added a new file [1], I think
> you may only need to add it to Makefile.am.
> 
Yes, you should only add this to Makefile.am. Makefile.in is generated by 
running autogen.sh.

David,

I pulled in your branch from github. Besides the issue of the missing entry in 
Makefile.am, there is also a syntax error now in the link to Wikipedia.

The xref is not closed properly, but you probably want ulink instead of xref 
here. xref is only for references to other parts of the same document:
http://en.wikipedia.org; />

Lastly, when I build the html documentation using xsltproc I don't see any of 
the errors you mention. So something is going on on your system only. I have 
no idea unfortunately what it could be.

Geert

___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

RE: XML Parse error on Local Build

[Chris Good]

From: David T. [mailto:sunfis...@yahoo.com] 
Sent: Wednesday, 7 December 2016 4:04 PM
To: Chris Good <chris.g...@ozemail.com.au>
Cc: gnucash-devel@gnucash.org
Subject: Re: XML Parse error on Local Build

 

 

On Dec 7, 2016, at 9:39 AM, Chris Good <chris.g...@ozemail.com.au 
<mailto:chris.g...@ozemail.com.au> > wrote:





-Original Message-
From: David T. [mailto:sunfis...@yahoo.com]
Sent: Wednesday, 7 December 2016 2:42 PM
To: Chris Good <chris.g...@ozemail.com.au <mailto:chris.g...@ozemail.com.au> >
Cc: gnucash-devel@gnucash.org <mailto:gnucash-devel@gnucash.org> ; 
frank.h.ellenber...@gmail.com <mailto:frank.h.ellenber...@gmail.com> 
Subject: Re: XML Parse error on Local Build

Chris,

Thanks for the response. Initially, I thought that I had accidentally inserted
duplicate entries in the glossary; however, the errors persisted even after I
changed them all in my file. Further examination of the long chain of errors
shows me that they encompass all areas of the documentation—including
ones that I did not touch at all.

I suspect that there is some simple aspect to the process that I am missing,
and somewhere on my system is a second instance that the command finds
and barks about. Over and over and over again. But like the young wizards in
an adventure tale, I don’t fully understand the content of the incantations I
invoke before I make them, and I think I need a Dumbledore to explain to
me the errors of my ways…

Thanks,
David


Hi David,

Are you sure you're running 2 separate commands:
 xmllint --valid --noout gnucash-guide.xml 
and
xsltproc -o ../../../output_html/guide/ ../../xsl/general-customization.xsl 
gnucash- guide.xml

They seem to have been joined together (maybe just by mail).

Maybe doing from the guide/C directory:
grep -n invest-split1 *.xml
will help identify the problem (-n means print the line no's in the file(s) 
where the string is found).
Id 'invest-split1' must only be defined once in all xml files in the directory 
but it can be linked to multiple times like:


Regards, Chris Good

 

Yes, definitely different commands. 

 

Grep turns up only one entry for the particular example I included.

 

The reason I suspect I am missing a broad step on my system is that there are 
596 different instances of this same basic error every time I run the command, 
so it’s not a matter of a couple of typos in my changes. There’s something I 
need to do differently to remove these (what I believe to be spurious) errors. 

 

Another possibility is that in modifying gnucash-guide.xml to include the new 
glossary file, I somehow messed that file up so that the compile process is 
revisiting some of the files. That would explain the duplication. However, I 
literally added 2 lines to gnucash-guide.xml, adding:

 







to the list of files at line 34, and:

 



 

to the main  definition at line 519. From my understanding, this 
shouldn’t cause the multitude of errors.

 

Cheers,

David

 

Hi David,

 

As you’re adding a new file, I think you also need to add it to Makefile.in and 
Makefile.am. Just follow what you see in those.

 

>From looking at one of the prior commits which added a new file [1], I think 
>you may only need to add it to Makefile.am.

 

[1] 
https://github.com/Gnucash/gnucash-docs/commit/f807ca04401a0d9453b19aba733982737fd967de

 

Regards, Chris Good



smime.p7s
Description: S/MIME cryptographic signature
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[David T. via gnucash-devel]

> On Dec 7, 2016, at 9:39 AM, Chris Good <chris.g...@ozemail.com.au> wrote:
> 
>> -Original Message-
>> From: David T. [mailto:sunfis...@yahoo.com]
>> Sent: Wednesday, 7 December 2016 2:42 PM
>> To: Chris Good <chris.g...@ozemail.com.au>
>> Cc: gnucash-devel@gnucash.org; frank.h.ellenber...@gmail.com
>> Subject: Re: XML Parse error on Local Build
>> 
>> Chris,
>> 
>> Thanks for the response. Initially, I thought that I had accidentally 
>> inserted
>> duplicate entries in the glossary; however, the errors persisted even after I
>> changed them all in my file. Further examination of the long chain of errors
>> shows me that they encompass all areas of the documentation—including
>> ones that I did not touch at all.
>> 
>> I suspect that there is some simple aspect to the process that I am missing,
>> and somewhere on my system is a second instance that the command finds
>> and barks about. Over and over and over again. But like the young wizards in
>> an adventure tale, I don’t fully understand the content of the incantations I
>> invoke before I make them, and I think I need a Dumbledore to explain to
>> me the errors of my ways…
>> 
>> Thanks,
>> David
>> 
> 
> Hi David,
> 
> Are you sure you're running 2 separate commands:
>  xmllint --valid --noout gnucash-guide.xml 
> and
> xsltproc -o ../../../output_html/guide/ ../../xsl/general-customization.xsl 
> gnucash- guide.xml
> 
> They seem to have been joined together (maybe just by mail).
> 
> Maybe doing from the guide/C directory:
> grep -n invest-split1 *.xml
> will help identify the problem (-n means print the line no's in the file(s) 
> where the string is found).
> Id 'invest-split1' must only be defined once in all xml files in the 
> directory but it can be linked to multiple times like:
> 
> 
> Regards, Chris Good

Yes, definitely different commands. 

Grep turns up only one entry for the particular example I included.

The reason I suspect I am missing a broad step on my system is that there are 
596 different instances of this same basic error every time I run the command, 
so it’s not a matter of a couple of typos in my changes. There’s something I 
need to do differently to remove these (what I believe to be spurious) errors. 

Another possibility is that in modifying gnucash-guide.xml to include the new 
glossary file, I somehow messed that file up so that the compile process is 
revisiting some of the files. That would explain the duplication. However, I 
literally added 2 lines to gnucash-guide.xml, adding:



to the list of files at line 34, and:



to the main  definition at line 519. From my understanding, this 
shouldn’t cause the multitude of errors.

Cheers,
David
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

RE: XML Parse error on Local Build

[Chris Good]

>> Message: 3
> >> Date: Tue, 6 Dec 2016 17:05:37 +0500
> >> From: "David T." <sunfis...@yahoo.com>
> >> To: "David T. via gnucash-devel" <gnucash-devel@gnucash.org>
> >> Subject: XML Parse error on Local Build
> >> Message-ID: <117685e8-ee9b-44e2-b3b3-6179f5a08...@yahoo.com>
> >> Content-Type: text/plain;  charset=utf-8
> >>
> >> Hi,
> >>
> >> I am trying to finish a first pass at a new Glossary for the Guide.
> >> My
> > changes
> >> are focused in a new file (gnc-glossary.xml) and in
> >> gnucash-guide.xml. In
> > the
> >> latter, I have added two lines to incorporate the new file into the guide.
> >>
> >> I have reached the point of running the commands:
> >>
> >> xmllint --valid --noout gnucash-guide.xml xsltproc -o
> >> ../../../output_html/guide/ ../../xsl/general-customization.xsl
> >> gnucash- guide.xml
> >>
> >> These are prescribed by the Wiki page. The first passes cleanly, but
> >> when
> > I
> >> run the second, I receive a multitude of errors along the lines of:
> >>
> >> gnucash-guide.xml:2964: element screenshot: validity error : ID
> > invest-split1
> >> already defined
> >>
> >> The process completes, and I am able to view the documentation, but I
> >> don?t know whether these errors indicate something else wrong with my
> >> modifications.
> >>
> >> Can anyone advise?
> >>
> >> Thanks,
> >> David
> >>
> >
> > On Dec 7, 2016, at 3:32 AM, Chris Good <chris.g...@ozemail.com.au>
> wrote:
>> > Hi David,
> >
> > Great to see all the documentation improvements you are doing.
> >
> > The id's should be unique so you can link to them from elsewhere in
> > the documentation.
> > I think they only need to be unique within either the guide or help
> > but ideally should be globally unique.
> >
> > Now that you mention it, I thought it would be better to not have id's
> > unless they are referenced from somewhere else as this may speed up
> > the lint and xsltproc processes (which seems to be getting much longer
> > recently) but Frank Ellenberger suggested they be used anyway as that
> > seems to be the standard. We were talking about sect rather than
> screenshot id's I think.
> > Opinions?
> >
> > Regards,
> > Chris Good

> -Original Message-
> From: David T. [mailto:sunfis...@yahoo.com]
> Sent: Wednesday, 7 December 2016 2:42 PM
> To: Chris Good <chris.g...@ozemail.com.au>
> Cc: gnucash-devel@gnucash.org; frank.h.ellenber...@gmail.com
> Subject: Re: XML Parse error on Local Build
> 
> Chris,
> 
> Thanks for the response. Initially, I thought that I had accidentally inserted
> duplicate entries in the glossary; however, the errors persisted even after I
> changed them all in my file. Further examination of the long chain of errors
> shows me that they encompass all areas of the documentation—including
> ones that I did not touch at all.
> 
> I suspect that there is some simple aspect to the process that I am missing,
> and somewhere on my system is a second instance that the command finds
> and barks about. Over and over and over again. But like the young wizards in
> an adventure tale, I don’t fully understand the content of the incantations I
> invoke before I make them, and I think I need a Dumbledore to explain to
> me the errors of my ways…
> 
> Thanks,
> David
>

Hi David,

Are you sure you're running 2 separate commands:
  xmllint --valid --noout gnucash-guide.xml 
 and
 xsltproc -o ../../../output_html/guide/ ../../xsl/general-customization.xsl 
gnucash- guide.xml

They seem to have been joined together (maybe just by mail).

Maybe doing from the guide/C directory:
 grep -n invest-split1 *.xml
will help identify the problem (-n means print the line no's in the file(s) 
where the string is found).
Id 'invest-split1' must only be defined once in all xml files in the directory 
but it can be linked to multiple times like:


Regards, Chris Good


smime.p7s
Description: S/MIME cryptographic signature
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

Re: XML Parse error on Local Build

[David T. via gnucash-devel]

Chris,

Thanks for the response. Initially, I thought that I had accidentally inserted 
duplicate entries in the glossary; however, the errors persisted even after I 
changed them all in my file. Further examination of the long chain of errors 
shows me that they encompass all areas of the documentation—including ones that 
I did not touch at all.

I suspect that there is some simple aspect to the process that I am missing, 
and somewhere on my system is a second instance that the command finds and 
barks about. Over and over and over again. But like the young wizards in an 
adventure tale, I don’t fully understand the content of the incantations I 
invoke before I make them, and I think I need a Dumbledore to explain to me the 
errors of my ways…

Thanks,
David

> On Dec 7, 2016, at 3:32 AM, Chris Good  wrote:
> 
>> Message: 3
>> Date: Tue, 6 Dec 2016 17:05:37 +0500
>> From: "David T." 
>> To: "David T. via gnucash-devel" 
>> Subject: XML Parse error on Local Build
>> Message-ID: <117685e8-ee9b-44e2-b3b3-6179f5a08...@yahoo.com>
>> Content-Type: text/plain;charset=utf-8
>> 
>> Hi,
>> 
>> I am trying to finish a first pass at a new Glossary for the Guide. My
> changes
>> are focused in a new file (gnc-glossary.xml) and in gnucash-guide.xml. In
> the
>> latter, I have added two lines to incorporate the new file into the guide.
>> 
>> I have reached the point of running the commands:
>> 
>> xmllint --valid --noout gnucash-guide.xml xsltproc -o
>> ../../../output_html/guide/ ../../xsl/general-customization.xsl gnucash-
>> guide.xml
>> 
>> These are prescribed by the Wiki page. The first passes cleanly, but when
> I
>> run the second, I receive a multitude of errors along the lines of:
>> 
>> gnucash-guide.xml:2964: element screenshot: validity error : ID
> invest-split1
>> already defined
>> 
>> The process completes, and I am able to view the documentation, but I
>> don?t know whether these errors indicate something else wrong with my
>> modifications.
>> 
>> Can anyone advise?
>> 
>> Thanks,
>> David
>> 
> 
> Hi David,
> 
> Great to see all the documentation improvements you are doing.
> 
> The id's should be unique so you can link to them from elsewhere in the
> documentation.
> I think they only need to be unique within either the guide or help but
> ideally should be globally unique.
> 
> Now that you mention it, I thought it would be better to not have id's
> unless they are referenced from somewhere else as this may speed up the lint
> and xsltproc processes (which seems to be getting much longer recently) but
> Frank Ellenberger suggested they be used anyway as that seems to be the
> standard. We were talking about sect rather than screenshot id's I think.
> Opinions?
> 
> Regards,
> Chris Good


___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

RE: XML Parse error on Local Build

[Chris Good]

> Message: 3
> Date: Tue, 6 Dec 2016 17:05:37 +0500
> From: "David T." 
> To: "David T. via gnucash-devel" 
> Subject: XML Parse error on Local Build
> Message-ID: <117685e8-ee9b-44e2-b3b3-6179f5a08...@yahoo.com>
> Content-Type: text/plain; charset=utf-8
> 
> Hi,
> 
> I am trying to finish a first pass at a new Glossary for the Guide. My
changes
> are focused in a new file (gnc-glossary.xml) and in gnucash-guide.xml. In
the
> latter, I have added two lines to incorporate the new file into the guide.
> 
> I have reached the point of running the commands:
> 
> xmllint --valid --noout gnucash-guide.xml xsltproc -o
> ../../../output_html/guide/ ../../xsl/general-customization.xsl gnucash-
> guide.xml
> 
> These are prescribed by the Wiki page. The first passes cleanly, but when
I
> run the second, I receive a multitude of errors along the lines of:
> 
> gnucash-guide.xml:2964: element screenshot: validity error : ID
invest-split1
> already defined
> 
> The process completes, and I am able to view the documentation, but I
> don?t know whether these errors indicate something else wrong with my
> modifications.
> 
> Can anyone advise?
> 
> Thanks,
> David
> 

Hi David,

Great to see all the documentation improvements you are doing.

The id's should be unique so you can link to them from elsewhere in the
documentation.
I think they only need to be unique within either the guide or help but
ideally should be globally unique.

Now that you mention it, I thought it would be better to not have id's
unless they are referenced from somewhere else as this may speed up the lint
and xsltproc processes (which seems to be getting much longer recently) but
Frank Ellenberger suggested they be used anyway as that seems to be the
standard. We were talking about sect rather than screenshot id's I think.
Opinions?

Regards,
Chris Good


smime.p7s
Description: S/MIME cryptographic signature
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel