Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / fpc-devel / 2015-02

FPC CHM files

5 messages · 3 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Marco van de Voort
to Mattias Gaertner

In our previous episode, Mattias Gaertner said:

I'm searching for the newest version of chm files (rtl, fcl, user, fpdoc, prog, ref, toc). Where is the most recent snapshot?

January snapshot (for 3.0 doc build testing)

http://www.stack.nl/~marcov/doc-chm_with_lcl_trunk_trunk.zip

Show quoted text 6 lines
If there are no snapshots: Is it still so complicated as described here: http://wiki.lazarus.freepascal.org/chm_backend_for_fpdoc#Generating_FPC_CHM_docs_for_the_latex_documentation From memory what I do is

Once:
- install latex
- install tex4ht (nowadays just from package, in the past this was torture)

Everytime:
- with a full snapshot of FPC available run fpcdocs/fixdocs.sh with the sources of FPC at ../fpc
- Switch to lazarus
- make sure all xml docs for all units exists. This usually takes most time.
- Check location of fpdoc dir in build_lcl_chm.sh it needs to find the generated FPC docs for cross referencing.
- run doc/html/build_lcl_chm.sh

- Gather all chm, xct and non zero .kwds. Package in a help/ with the readme from fpcdocs repo

The last snapshot was smaller than the previous, so there might still be trunk fpdoc issues. But I don't have a lead what exactly is wrong with them.

Messing with threading can be very rewarding, about halving build times. I had corrupt chms on occasion though, but not reproducable.

Reply by email

Mark Morgan Lloyd
to Marco van de Voort
Marco van de Voort wrote
Once: - install latex - install tex4ht (nowadays just from package, in the past this was torture)

I notice that tex4ht is mandated by various things including OpenWRT, which provides an incentive for mainstream distreaux to get it right.

Show quoted text 8 lines
Everytime: - with a full snapshot of FPC available run fpcdocs/fixdocs.sh with the sources of FPC at ../fpc - Switch to lazarus - make sure all xml docs for all units exists. This usually takes most time. - Check location of fpdoc dir in build_lcl_chm.sh it needs to find the generated FPC docs for cross referencing. - run doc/html/build_lcl_chm.sh

I wonder if I could ask a related question. A year or so ago I was playing around, trying to see if I could generate a list of which version of FPC gained each function, and trying to generate a permuted index to help answer the "how do I" FAQs. I ran into various problems which gave me the impression that the raw help file data required the utilities in the matching FPC version: is that reasonable, or should the format from 2.0.0 onwards be absolutely invariant?

Mark Morgan Lloyd markMLl .AT. telemetry.co .DOT. uk [Opinions above are the author's, not those of his employers or colleagues]

Reply by email

Mattias Gaertner
to Marco van de Voort: In our previous episode, Mattias Gaertner said: January snapshot (for 3.0 doc build…
Show quoted text 9 lines
In our previous episode, Mattias Gaertner said: > > I'm searching for the newest version of chm files (rtl, fcl, user, > fpdoc, prog, ref, toc). > Where is the most recent snapshot? January snapshot (for 3.0 doc build testing) http://www.stack.nl/~marcov/doc-chm_with_lcl_trunk_trunk.zip

Great. Thanks.

Show quoted text 10 lines
> If there are no snapshots: Is it still so complicated as described > here: > > http://wiki.lazarus.freepascal.org/chm_backend_for_fpdoc#Generating_FPC_CHM_docs_for_the_latex_documentation From memory what I do is Once: - install latex - install tex4ht (nowadays just from package, in the past this was torture)

ok

Everytime: - with a full snapshot of FPC available run fpcdocs/fixdocs.sh with the sources of FPC at ../fpc

ok, then this file exists:
../fpc/compiler/version.pas

Running "sh -x fixdocs.sh" gives:

...
+ ./compilelatexchm prog 'Programmer'\''s Guide'
skipping .
skipping ..
An unhandled exception occurred at $00000000004591F6 : EFOpenError : Unable to open file "prog/prog.html" $00000000004591F6
$0000000000458F47
$000000000042F435
$00000000004016D2
$0000000000402611

Maybe first the html must be built?

Show quoted text 14 lines
- Switch to lazarus - make sure all xml docs for all units exists. This usually takes most time. - Check location of fpdoc dir in build_lcl_chm.sh it needs to find the generated FPC docs for cross referencing. - run doc/html/build_lcl_chm.sh - Gather all chm, xct and non zero .kwds. Package in a help/ with the readme from fpcdocs repo The last snapshot was smaller than the previous, so there might still be trunk fpdoc issues. But I don't have a lead what exactly is wrong with them. Messing with threading can be very rewarding, about halving build times. I had corrupt chms on occasion though, but not reproducable.

Mattias

Reply by email

Marco van de Voort
to Mattias Gaertner

In our previous episode, Mattias Gaertner said:

Show quoted text 25 lines
ok > Everytime: > - with a full snapshot of FPC available run fpcdocs/fixdocs.sh with the sources of FPC at > ../fpc ok, then this file exists: ../fpc/compiler/version.pas Running "sh -x fixdocs.sh" gives: ... + ./compilelatexchm prog 'Programmer'\''s Guide' skipping . skipping .. An unhandled exception occurred at $00000000004591F6 : EFOpenError : Unable to open file "prog/prog.html" $00000000004591F6 $0000000000458F47 $000000000042F435 $00000000004016D2 $0000000000402611 Maybe first the html must be built?

The make command is in the script. Must be bash or missing gmake.

Reply by email