Sign in Join

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

Mailing lists / lazarus / 2022-12

Attn. Don, documentation snapshots via CI

3 messages · 3 people · –

Reply by email Subscribe to this list Your subscription

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

Maxim Ganetsky

Hello.

As a first step of solving outdated documentation snapshot issue (https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues/40032 ) I propose to generate it as an artifact of CI job (in `main` branch for now), which then can be uploaded wherever we want.

So I have the following questions:

1. FPDoc from which FPC version is preferred (from `main` branch I guess)?
2. Where rtl.xct and fcl.xct should be obtained? Should FPC documentation be built first?
3. Should we build HTML, CHM or both?
4. Are there any dependencies beyond Lazarus, FPC and their sources?

Best regards, Maxim Ganetsky mailto:

Reply by email

Michael Van Canneyt
to Maxim Ganetsky
Maxim Ganetsky wrote 10 lines
Hello. As a first step of solving outdated documentation snapshot issue (https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues/40032 ) I propose to generate it as an artifact of CI job (in `main` branch for now), which then can be uploaded wherever we want. So I have the following questions: 1. FPDoc from which FPC version is preferred (from `main` branch I guess)?

main.

2. Where rtl.xct and fcl.xct should be obtained? Should FPC documentation be built first?

rtl.xct and fcl.xct are generated when the FPC documentation is built.

However, note that the documentation of FPC is only updated after a release. so if you use FPC main to generate documentation, it will not match what FPC publishes.

3. Should we build HTML, CHM or both?

If it is for upload, then CHM makes no sense to me, but that's up to the lazarus team, obviously...

Michael.

Reply by email

Marco van de Voort
to Michael Van Canneyt
Michael Van Canneyt wrote 5 lines
If it is for upload, then CHM makes no sense to me, but that's up to the lazarus team, obviously...

CHM is due to its compression also quite CPU hungry. Generating the LCL chm would keep a core occupied for minutes.

I certain think CHM snapshots are worthwhile, for IDE integration, but monthly or so is enough.

Reply by email