Recent

Author Topic: docs updates but smaller  (Read 1517 times)

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 8458
  • FPC developer.
docs updates but smaller
« on: January 13, 2020, 09:30:15 pm »
I rebuilt FPC and lazarus CHM docs based on the FPC 3.2.x branch and lazarus trunk.

It seems the Lazarus documentation has gotten smaller, which could indicate a fpdoc problem. However the FPC docs are fine?!?!

If anybody notices anything, please comment here.

The archive at http:/www.stack.nl/~marcov/doc-chmbeta.zip has been updates (24.2 MB, was 24.9 MB)

dsiders

  • Sr. Member
  • ****
  • Posts: 305
Re: docs updates but smaller
« Reply #1 on: January 13, 2020, 09:53:08 pm »
I rebuilt FPC and lazarus CHM docs based on the FPC 3.2.x branch and lazarus trunk.

It seems the Lazarus documentation has gotten smaller, which could indicate a fpdoc problem. However the FPC docs are fine?!?!

If anybody notices anything, please comment here.

The archive at http:/www.stack.nl/~marcov/doc-chmbeta.zip has been updates (24.2 MB, was 24.9 MB)

The problem is that lcl.chm and lazutils.chm have no content at all provided by the XML files. Everything you're seeing is the generated output from FPDoc.

user.chm also got smaller, but I can't see an obvious reason for it yet.

Lazarus 2.1 (SVN) / FPC 3.0.4 / FPC 3.2.0 / x86-win64 / Windows 8.1

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 8458
  • FPC developer.
Re: docs updates but smaller
« Reply #2 on: January 13, 2020, 09:59:07 pm »
That would make sense and point to another BOM problem in build_lcl_docs.lpr.

I'll see if I can build it with a 3.2 fpdoc instead of a 3.3.1 fpdoc.

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 8458
  • FPC developer.
Re: docs updates but smaller
« Reply #3 on: January 16, 2020, 10:11:20 pm »
I tried again today. No results but some observations:

  • Fpc files are correctly generated
  • lazutils and lcll not
  • there is a BOM problem with the savetofile in build_lcl_docs but that is easily fixed
  • I thought it was something with relative paths, but this is probably ok.
  • In the fpdoc output of lazutils/lcl I see less output
  • Fixes fpdoc has the same problem

Afaik the FPC docs are now compiled over project files. So maybe something is broken in the cmdline handling.
« Last Edit: January 16, 2020, 10:14:02 pm by marcov »

dsiders

  • Sr. Member
  • ****
  • Posts: 305
Re: docs updates but smaller
« Reply #4 on: January 16, 2020, 10:54:03 pm »
I tried again today. No results but some observations:

  • Fpc files are correctly generated
  • lazutils and lcll not
  • there is a BOM problem with the savetofile in build_lcl_docs but that is easily fixed
  • I thought it was something with relative paths, but this is probably ok.
  • In the fpdoc output of lazutils/lcl I see less output
  • Fixes fpdoc has the same problem

Afaik the FPC docs are now compiled over project files. So maybe something is broken in the cmdline handling.

Looking at the buildlcllog.txt, I found an error when it is writing pages.

Code: [Select]
#lcl.WSControls.TWSWinControl.GetPreferredSize] Invalid description (illegFPDoc - Free Pascal Documentation Tool
It's a content error in lcl/WSControls.xml. I am posting a bug report to correct it. Not sure if that might be the problem.

Bug report: https://bugs.freepascal.org/view.php?id=36594
Fixed in Revision 62566
« Last Edit: January 17, 2020, 12:44:10 am by dsiders »
Lazarus 2.1 (SVN) / FPC 3.0.4 / FPC 3.2.0 / x86-win64 / Windows 8.1

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 8458
  • FPC developer.
Re: docs updates but smaller
« Reply #5 on: January 21, 2020, 09:52:20 pm »
Ok,  I solved it I think, the pkg on the URL above is now nearly a MB larger.

Probably while debugging the BOM problem, I did what people should never do. I ran ...... Perl code (docs/xml/multi_makeskel.pl), which probably overwrote all my XMLs with empty skeletons.

So I was searching for more code bugs, but there were none, it was an input problem.

Quote
  481271  buildlcllog.txt
  882363  buildlog.txt
 2435414  fcl.chm
  471755  fclres.chm
   59591  fclres.xct
  225957  fcl.xct
   89749  fpdoc.chm
 1915568  lazutils.chm
  262398  lazutils.xct
25741317  lcl.chm
 1445477  lcl.xct
  426000  prog.chm
    4186  readmechm.txt
  951263  ref.chm
    6115  ref.kwd
 4019651  rtl.chm
  406272  rtl.xct
    6983  toc.chm
  445766  user.chm



PascalDragon

  • Hero Member
  • *****
  • Posts: 1694
  • Compiler Developer
Re: docs updates but smaller
« Reply #6 on: January 21, 2020, 11:07:35 pm »
Probably while debugging the BOM problem, I did what people should never do. I ran ...... Perl code (docs/xml/multi_makeskel.pl), which probably overwrote all my XMLs with empty skeletons.
Couldn't this be replaced by a Pascal solution? I mean, it wouldn't solve the problem of accidentally executing it, but at least it wouldn't be Perl anymore. :P

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 8458
  • FPC developer.
Re: docs updates but smaller
« Reply #7 on: January 22, 2020, 11:39:02 am »
Probably while debugging the BOM problem, I did what people should never do. I ran ...... Perl code (docs/xml/multi_makeskel.pl), which probably overwrote all my XMLs with empty skeletons.
Couldn't this be replaced by a Pascal solution?

Well, that would require reading Perl code, which everybody knows is impossible. >:D

 

TinyPortal © 2005-2018