Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Abou Al Montacir]

Hi Lazarus Developers List,

Can you please help on this issue?
fpdoc fails when building Laazarus 1.6.2 documentation. This leads to a serious
(RC) bug that may lead to remove Lazarus form next Debian release which will be
really a pity.

On Sat, 2017-04-01 at 21:45 +0200, Paul Gevers wrote:
> First shot at debugging from my side.
> 
> Because the error says:
> Exception at 004BDB6C: EDOMError:
> EDOMError in DOMDocument.CreateElement.
> 
> I searched for "DOMDocument.CreateElement". Low and behold, I find
> something interesting in fpcsrc/packages/fcl-xml/src/dom.pp:
> 
> function TDOMDocument.CreateElement(const tagName: DOMString): TDOMElement;
> begin
>   if not IsXmlName(tagName) then
> raise EDOMError.Create(INVALID_CHARACTER_ERR,
> 'DOMDocument.CreateElement');
>   TDOMNode(Result) := Alloc(TDOMElement);
> 
> Result.Create(Self);
>   Result.FNSI.QName := FNames.FindOrAdd(DOMPChar(tagName), Length(tagName));
>   Result.AttachDefaultAttrs;
> end;
> 
> First idea that pops into my mind is: it looks like the source of
> lazarus has characters that fp-docs can't convert. Apparently an error
> is raised, but converted by fp-docs into exit code 0.
> 
> Interesting to note, is the delta between 2.4.6 and 3.0.0:
> -  if not IsXmlName(tagName, FXMLVersion = xmlVersion11) then
> +  if not IsXmlName(tagName) then
> which was done in this commit:
> http://svn.freepascal.org/cgi-bin/viewvc.cgi?view=revision=20422
> 
> Sending now as I am about to stop for today, but summary as I currently
> suspect the situation is:
> 1) fp-doc fails to create error exit code during error
> 2) lazarus may have xml files that need updating.
> 
> Probably the next time I spend time on this will be to bisect the
> documentation creation to see which file(s) need fixing -> to
> potentially solve issue 2 if that is indeed the issue.
It looks like the file extctrls.pp or the corresponding xml is not supported by
the used version of fpdoc.
]$fpdoc --content=lcl.xct --package=lcl --descr=../../xml/lcl/lcl.xml --
input='../../../lcl/extctrls.pp -Fi../../../lcl/include'  --format=html --
descr=../../xml/lcl/extctrls.xmlFPDoc - Free Pascal Documentation ToolVersion
3.0.0 [2017/02/08](c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther, sg@fr
eepascal.org(c) 2005 - 2012 various FPC contributors
Writing 757 pages...Exception at 004BDACC: EDOMError:EDOMError in
DOMDocument.CreateElement.While with an other page this leads to:
$fpdoc --content=lcl.xct --package=lcl --descr=../../xml/lcl/lcl.xml --
input='../../../lcl/interfaces/gtk/gtkwsextctrls.pp -Fi../../../lcl/include'  
--format=html --descr=../../xml/lcl/interfaces/gtk/gtkwsextctrls.xmlFPDoc - Free
Pascal Documentation ToolVersion 3.0.0 [2017/02/08](c) 2000 - 2003 Areca Systems
GmbH / Sebastian Guenther, s...@freepascal.org(c) 2005 - 2012 various FPC
contributors
Writing 128 pages...Using built-in CSS fileCreating plus imageCreating minus
imageDone.Here there are no errors. Just goes fine to end.
-- 
Cheers,
Abou Al Montacir

signature.asc
Description: This is a digitally signed message part

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Paul Gevers]

Hi Peter,

On 04/01/17 11:24, peter green wrote:
> On 31/03/17 19:11, Paul Gevers wrote:
>> On Fri, 24 Mar 2017 19:46:23 +0100 Abou Al Montacir
>>  wrote:
>>> OK, I'm going to have a look at the code and guess what it the issue.
>>> If I don't manage to get any idea I'll ask upstream.
>> I am just curious, are you progressing on this issue? Did you contact
>> upstream about it? If so, is the conversation public and can you share a
>> link to it?
> Umm, this discussion is being sent to a Debian bug report, so of course
> it's public.

Sorry if I wasn't clear. For the question about the link to the
conversation, I meant a possible discussion with upstream. I don't
expect upstream to look here. In the Debian bug, I don't remember seeing
any further information from Abou or upstream after the note I quoted above.

Paul



signature.asc
Description: OpenPGP digital signature

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Stephen Kitt]

On Sat, Apr 01, 2017 at 10:24:27AM +0100, peter green wrote:
> On 31/03/17 19:11, Paul Gevers wrote:
> > On Fri, 24 Mar 2017 19:46:23 +0100 Abou Al Montacir
> >  wrote:
> > > OK, I'm going to have a look at the code and guess what it the issue.
> > > If I don't manage to get any idea I'll ask upstream.
> > I am just curious, are you progressing on this issue? Did you contact
> > upstream about it? If so, is the conversation public and can you share a
> > link to it?
> Umm, this discussion is being sent to a Debian bug report, so of course it's 
> public.

I’m guessing Paul is referring to the putative discussion between Abou
and upstream, which hasn’t been sent to the bug report.

Regards,

Stephen


signature.asc
Description: PGP signature

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[peter green]

On 31/03/17 19:11, Paul Gevers wrote:

Hi Abou,

On Fri, 24 Mar 2017 19:46:23 +0100 Abou Al Montacir
 wrote:

OK, I'm going to have a look at the code and guess what it the issue.
If I don't manage to get any idea I'll ask upstream.

I am just curious, are you progressing on this issue? Did you contact
upstream about it? If so, is the conversation public and can you share a
link to it?

Umm, this discussion is being sent to a Debian bug report, so of course it's 
public.

Of course I want to help, but I have no idea where to start or what to do.

Paul

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Paul Gevers]

Hi Abou,

On Fri, 24 Mar 2017 19:46:23 +0100 Abou Al Montacir
 wrote:
> OK, I'm going to have a look at the code and guess what it the issue.
> If I don't manage to get any idea I'll ask upstream.

I am just curious, are you progressing on this issue? Did you contact
upstream about it? If so, is the conversation public and can you share a
link to it?

Of course I want to help, but I have no idea where to start or what to do.

Paul




signature.asc
Description: OpenPGP digital signature

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Paul Gevers]

Hi Abou,

On 24-03-17 19:42, Abou Al Montacir wrote:
> OK so fpdoc craches and thus no files are generated. The install dir is empty
> and the package too.

Not that it matters much, but shouldn't this bug be reassigned to fpc
then and the bug marked as "affects lazarus"?

Paul




signature.asc
Description: OpenPGP digital signature

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Abou Al Montacir]

On Thu, 23 Mar 2017 21:20:53 +0100 Paul Gevers  wrote:
> Reproducible in Ubuntu, the package is empty there, and in my pbuilder
> environment. Looks like build_lcl_docs is broken somehow.
> 
> @Abou, can you take this up with upstream or shine your own light on it?
> I have now idea what to do next. Also, do you have any idea what an
> Exception isn't returning an error value as exit code? Seems like a
> serious fpc or build_lcl_docs issue if you ask me. (I added the
> --warnings to avoid any doubt what useful warnings were hidden).
> 
> $ ./build_lcl_docs --outfmt html --warnings
> Warning! No corresponding xml file for unit customdrawn_mac.pas
...
> interfaces/customdrawn/android/bitmap.pas
> Warning! No corresponding xml file for unit

OK, I'm going to have a look at the code and guess what it the issue.
If I don't manage to get any idea I'll ask upstream.
-- 
Cheers,
Abou Al Montacir

signature.asc
Description: This is a digitally signed message part

Bug#858553: [Pkg-pascal-devel] Bug#858553: [lazarus-doc-1.6] Package lazarus-doc-1.6 is empty and does not ship documentation files

[Paul Gevers]

Reproducible in Ubuntu, the package is empty there, and in my pbuilder
environment. Looks like build_lcl_docs is broken somehow.

@Abou, can you take this up with upstream or shine your own light on it?
I have now idea what to do next. Also, do you have any idea what an
Exception isn't returning an error value as exit code? Seems like a
serious fpc or build_lcl_docs issue if you ask me. (I added the
--warnings to avoid any doubt what useful warnings were hidden).

$ ./build_lcl_docs --outfmt html --warnings
Warning! No corresponding xml file for unit customdrawn_mac.pas
Warning! No corresponding xml file for unit forms/calcform.pas
Warning! No corresponding xml file for unit forms/calendarpopup.pas
Warning! No corresponding xml file for unit forms/finddlgunit.pas
Warning! No corresponding xml file for unit forms/replacedlgunit.pas
Warning! No corresponding xml file for unit forms/timepopup.pas
Warning! No corresponding xml file for unit fpmake.pp
Warning! No corresponding xml file for unit
interfaces/cocoa/alllclintfunits.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoacaret.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoagdiobjects.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoaint.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoaprivate.pp
Warning! No corresponding xml file for unit interfaces/cocoa/cocoaproc.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoathemes.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoautils.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawsbuttons.pp
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawschecklst.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawscomctrls.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawscommon.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawsdialogs.pp
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawsextctrls.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawsfactory.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoawsforms.pp
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawsmenus.pas
Warning! No corresponding xml file for unit interfaces/cocoa/cocoawsspin.pas
Warning! No corresponding xml file for unit
interfaces/cocoa/cocoawsstdctrls.pp
Warning! No corresponding xml file for unit interfaces/cocoa/cocoa_extra.pas
Warning! No corresponding xml file for unit interfaces/cocoa/interfaces.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/alllclintfunits.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/android_native_app_glue.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/android_sockets.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/asset_manager.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/bitmap.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/configuration.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/egl.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/gles.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/input.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/jni.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/keycodes.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/log.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/looper.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/native_activity.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/native_window.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/android/rect.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/cocoagdiobjects.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/cocoautils.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnint.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnprivate.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnproc.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnthemes.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnwsbuttons.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnwscomctrls.pas
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnwscontrols.pp
Warning! No corresponding xml file for unit
interfaces/customdrawn/customdrawnwsdialogs.pas
Warning! No corresponding xml file for unit