Skip to content

Commit bc3a75f

Browse files
committed
Update old notes about compiling
1 parent b100bca commit bc3a75f

2 files changed

Lines changed: 22 additions & 32 deletions

File tree

src/CompilingPasDoc.asciidoc

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,15 @@ How to compile link:index[PasDoc]?
66

77
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.
88

9-
Compile by simple make in top level sources directory.
9+
Compile by simply executing
1010

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`.
1218

1319
### [[lazarus]] Lazarus
1420

@@ -18,52 +24,36 @@ Lazarus version required is 1.0.10 or later. Using the latest stable Lazarus ver
1824
* You can compile console pasdoc from Lazarus by compiling `source/console/pasdoc.lpi`.
1925
* You can compile `pasdoc_gui` from Lazarus by compiling `source/gui/pasdoc_gui.lpi`.
2026
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-
4527
## [[delphi]] Delphi
4628

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.
4830

4931
### [[compiling-from-the-ide-1]] Compiling from the IDE
5032

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.
5236

5337
### [[compiling-using-the-makefile-1]] Compiling using the Makefile
5438

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+
```
5644

5745
### [[delphi-5-specific-notes]] Delphi 5 specific notes
5846

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):
6048

6149
* Add "..\component\strutils" to your units search path.
6250
6351
### [[using-fastmm-memory-manager]] Using FastMM memory manager
6452

6553
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.
6654

55+
This is not necessary with newer Delphi versions, as they already include FastMM.
56+
6757
## [[see-also-release-making]] See also: release making
6858

6959
Compiling, testing and other things related to release making are described on this page: link:ReleaseMaking[ReleaseMaking].

src/ReleaseMaking.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Release making process:
1212
1313
## [[write-changelog-entry]] Write ChangeLog entry
1414

15-
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.
1616

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_.
1818

1919
## [[update-docs]] Update docs
2020

0 commit comments

Comments
 (0)