You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/CompilingPasDoc.asciidoc
+20-30Lines changed: 20 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,15 @@ How to compile link:index[PasDoc]?
6
6
7
7
The preferred http://www.freepascal.org/[FreePascal] version should always be the latest stable FPC release. Any FPC >= 2.6.0 is supported, although compilation with older versions is less extensively tested. Using the latest stable FPC is always the best option.
8
8
9
-
Compile by simple make in top level sources directory.
9
+
Compile by simply executing
10
10
11
-
You must use GNU make. Under Linux this is the standard make, under Windows it is included with FPC installation (you can also get it with http://www.mingw.org/[MinGW] or http://www.cygwin.com/[Cygwin]), under FreeBSD it's called gmake.
11
+
```
12
+
make
13
+
```
14
+
15
+
in the main repository directory.
16
+
17
+
NOTE: You must use GNU make. Under Linux this is the standard `make`. Under Windows it is included with FPC installation (you can also get it with http://www.mingw.org/[MinGW] or http://www.cygwin.com/[Cygwin]). Under FreeBSD it's called `gmake`.
12
18
13
19
### [[lazarus]] Lazarus
14
20
@@ -18,52 +24,36 @@ Lazarus version required is 1.0.10 or later. Using the latest stable Lazarus ver
18
24
* You can compile console pasdoc from Lazarus by compiling `source/console/pasdoc.lpi`.
19
25
* You can compile `pasdoc_gui` from Lazarus by compiling `source/gui/pasdoc_gui.lpi`.
20
26
21
-
### [[fpc-2.0.0]] FPC < 2.0.0
22
-
23
-
Compatibility with FPC 1.0.10 was dropped after pasdoc 0.9.0 release. If you must compile with FPC 1.0.10, you should use pasdoc 0.9.0 sources, later sources will not compile with FPC 1.0.10. For reasoning, browse http://lists.sourceforge.net/lists/listinfo/pasdoc-main[mailing list] archives for a thread *"Drop compatibility with Delphi 5 and FPC 1.0.10 ?"* around 2005-06-12.
24
-
25
-
Compatibility with FPC 1.9.x was dropped at some point too.
26
-
27
-
## [[kylix-3]] Kylix 3
28
-
29
-
### [[compiling-from-the-ide]] Compiling from the IDE
30
-
31
-
The unit output path is set to the 'lib' subdirectory which must be created manually. This is to reduce clutter.
32
-
33
-
The reason why the project file does not contain a list of all units including full filenames is that older versions of Delphi do not support a forward slash in paths while Kylix does not support backslashes. Sorry, you will have to live with that.
34
-
35
-
Do not use the "..." button to add directories to the search path, it will add absolute paths. Use relative paths instead.
36
-
37
-
### [[compiling-using-the-makefile]] Compiling using the Makefile
38
-
39
-
You can compile using the command make build-delphi-linux-x86
40
-
41
-
### [[older-kylix-versions]] Older Kylix versions
42
-
43
-
It is unknown whether the code compiles with older Kylix versions. Please report if you have any info.
44
-
45
27
## [[delphi]] Delphi
46
28
47
-
Supported Delphi versions are 5-7 and 2005.
29
+
In theory, the project can support even Delphi versions >= 5. However, it wasn't tested with so old Delphi versions for a long time. Using Delphi >= 11 is advised.
48
30
49
31
### [[compiling-from-the-ide-1]] Compiling from the IDE
50
32
51
-
The reason why the project file does not contain a list of all units including full filenames is that older versions of Delphi do not support a forward slash in paths while Kylix does not support backslashes. Sorry, you will have to live with that.
33
+
Open the Delphi project in `source/console/` and build as usual.
34
+
35
+
NOTE: The reason why the project file does not contain a list of all units including full filenames is that older versions of Delphi do not support a forward slash in paths while Kylix does not support backslashes. We may fix it, since we longer support Kylix.
52
36
53
37
### [[compiling-using-the-makefile-1]] Compiling using the Makefile
54
38
55
-
You can compile using the command make build-delphi-win32
39
+
You can compile using the command
40
+
41
+
```
42
+
make build-delphi-win32
43
+
```
56
44
57
45
### [[delphi-5-specific-notes]] Delphi 5 specific notes
58
46
59
-
You must do one specific thing to compile pasdoc with Delphi 5:
47
+
You must do one specific thing to compile pasdoc with Delphi 5 (and not later):
60
48
61
49
* Add "..\component\strutils" to your units search path.
62
50
63
51
### [[using-fastmm-memory-manager]] Using FastMM memory manager
64
52
65
53
You can speed up pasdoc a little (about 17%) by using http://sourceforge.net/projects/fastmm[FastMM memory manager]. Just download FastMM, add it to your Delphi units path, and define symbol USE_FASTMM when compiling.
66
54
55
+
This is not necessary with newer Delphi versions, as they already include FastMM.
56
+
67
57
## [[see-also-release-making]] See also: release making
68
58
69
59
Compiling, testing and other things related to release making are described on this page: link:ReleaseMaking[ReleaseMaking].
Make sure you have nice entry in https://github.com/pasdoc/pasdoc/blob/master/ChangeLog file in pasdoc sources.
15
+
Make sure you have nice entry in https://github.com/pasdoc/pasdoc/blob/master/ChangeLog.md file in pasdoc sources.
16
16
17
-
We try to write the ChangeLog entry_while_ developing PasDoc (each time someone does something significant, it's immediately added to the ChangeLog). So at this point, mainly _review and finalize (write new verion number and release date) ChangeLog entry_.
17
+
We try to update this changelog file_while_ developing PasDoc (each time someone does something significant, it's immediately added to the changelog). So at this point, mainly _review and finalize (write new verion number and release date) changelog entry_.
0 commit comments