Marģers . wrote

Is there a way to download human readable format documenation?

Please explain ?

The documentation is available as PDF. That's human readable ?

Looking documentation of 3.2.2 and it is bad. Errors and errors. Wanted to crosschech, maybe it is all fixed meanwhile.

You can check the actual state of documentation on the daily build: https://www.freepascal.org/daily/

Failing to compilde documentation by myself. Where to download or how to compile?

The documentation is in gitlab, just as the rest of FPC:

https://gitlab.com/freepascal.org/fpc/documentation

If you find errors in the documentation, the documentation bugtracker is also where you should report issues.

Simple "make" does not work. It is allways "Target not supported, run fpcmake". And that is not valid solution.

If you tried make to build the documentation, then I assume you downloaded the documentation so you should be aware of the gitlab location. So why do you ask where to download it ?

Anyway: I suspect you tried this on windows ?

Building the documentation on windows is not supported, you need linux to build the documentation.

Michael.

On 2024-05-09 09:17, Marģers . via fpc-devel wrote:

Hi,

Is there a way to download human readable format documenation? Looking documentation of 3.2.2 and it is bad. Errors and errors.

What do you mean with "errors and errors"?

Wanted to crosschech, maybe it is all fixed meanwhile.

Sources of the docs are available in Git and are "human readable", although obviously not as easily as the final output formats.

Failing to compilde documentation by myself. Where to download or how to compile?

Are you aware of the repository "Documentation"
(https://gitlab.com/freepascal.org/fpc/documentation) in Gitlab? Have you read the included README.md file (there is information on the supported targets)?

Simple "make" does not work. It is allways "Target not supported, run fpcmake". And that is not valid solution.

In order to build the complete docs, you need full sources as well, because descriptions of interfaces are directly generated from there. In order to do that, the "combined" repository "FPC Build" is used (with the approriate make target). However, note that there are some prerequisites (also described in the README.md).

Tomas

Well - if you mean that textual description, then you may want to check the latest state in the .xml files for the respective units. However, note that the description refers the released version and thus may not reflect recent changes in trunk.

If your "description" means information about parameters, their type, etc., (i.e. definition of the function interface), then note that this documentation is always generated from the respective sources (i.e. always correct from this point of view), however, it reflects the situation valid for the default target on which the documentation was generated which may result in certain differencies (e.g. in case that certain functions and/or their overloads are only available for certain targets, or that certain parameter types differ slightly among the targets for whatever reason - we try to avoid this as much as possible, but there are cases when this difference has certain impact).

Tomas