Fpcmake: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | **Fpcmake** is a [[makefile]] generator, to control the [[make]] [[utility]] by [[GNU]]. It generates a makefile named "Makefile" from a definition file called "Makefile.fpc" and its own built-in template. It is used in the FPC source tree (e.g. in FPC 2.6.0), but is planned to be succeeded by [[FPMake]]. | |
| 2 | 2 | ||
| 3 | 3 | This template is located in utils/fpcm/fpcmake.ini, but since fpcmake.ini is included in the binary (to avoid path-searching issues), fpcmake has to be regenerated for each fpcmake.ini change. | |
| 4 | 4 | ||
| 5 | 5 | The manual has a quite good [chapter about Makefile.fpc syntax](https://www.freepascal.org/docs-html/current/prog/progap5.html#x294-310000E), and examples teach the rest (fpcmake.ini, the various Makefile.fpcs in the FPC source tree). | |
| 6 | 6 | ||
| 7 | 7 | It defines some default targets that are always present: | |
| 8 | 8 | ||
| 9 | 9 | - Clean -- clean all programs and the units explicitly stated to be cleaned, but not other units. | |
| 10 | 10 | - Cleanall -- also clean all units (*.ppu). | |
| 11 | 11 | ||
| 12 | 12 | ## Troubleshooting | |
| 13 | 13 | ||
| 14 | 14 | - I get an error message that the command *__missing_command__* is missing. -- This happens when a tool required by the make process is not found. Remedy: Add the path to the tool as an option to make, like DATA2INC=/path/to/data2inc, for the tool data2inc | |
| 15 | 15 | - Clean does not delete the files I expect. -- This happens when the files were generated by a call to make where certain options were given. Remedy: Call make clean with the same options. Options which may affect this are: | |
| 16 | 16 | - OS_TARGET | |
| 17 | 17 | - CPU_TARGET | |
| 18 | 18 | - FPC or PP (Tells make which version of the compiler created the files, this affects *.*w files generated for Windows for fpc \< 1.1. To erase these files, please give an fpc 1.0 compiler as a parameter) | |
| 19 | 19 | - Make cannot find tools asw, ldw. Happens only when making for fpc 1.0.*. Remedy: Make a copy of the tools as and ld, rename them asw, ldw. | |
| 20 | 20 | - Target not supported: bad parameters were used when generating the makefile, you need to regenerate it with -Tall (see next paragraph) | |
| 21 | 21 | ||
| 22 | 22 | ## Regenerating makefiles | |
| 23 | 23 | ||
| 24 | 24 | Regenerating a *Makefile* from *Makefile.fpc* is quite easy. The basic syntax is | |
| 25 | 25 | ||
| 26 | - | ||
| 26 | + | ```text | |
| 27 | + | fpcmake -w -Tall | |
| 28 | + | ``` | |
| 27 | 29 | ||
| 28 | 30 | - -w : actually **write** the Makefile. | |
| 29 | 31 | - -Tall : generate the makefile so as to work on all platforms (default is only the host platform). | |
| 30 | 32 | ||
| 31 | - | ||
| 33 | + | ```text | |
| 34 | + | DON'T FORGET THIS WHEN COMMITTING TO FPC / LAZARUS SVN SERVER!. | |
| 35 | + | ``` | |
| 32 | 36 | ||
| 33 | 37 | For Lazarus developers: | |
| 34 | 38 | ||
| 35 | - | ||
| 39 | + | ```text | |
| 40 | + | YOU MUST USE THE FPC DEVELOPER VERSION (trunk, e.g. 2.7.1) TO GET ALL PLATFORMS. | |
| 41 | + | ``` | |
| 36 | 42 | ||
| 37 | 43 | - It is possible to add -v to increase verbosity. | |
| 38 | 44 | ||
| 39 | 45 | If you regenerate makefiles outside the fpc/ SVN tree, (e.g. for Lazarus in projects), and fpcmake complains it can't find package.fpc for the RTL package, try setting the environment variable FPCDIR to the FPC source directory using commands like the following: | |
| 40 | 46 | ||
| 41 | 47 | - Unix/Linux/OSX bash/sh | |
| 42 | 48 | ||
| 43 | 49 | ``` bash | |
| 44 | 50 | # e.g. if your FPC directory is located in /location/to/fpc: | |
| 45 | 51 | export FPCDIR=/location/to/fpc | |
| 46 | 52 | ``` | |
| 47 | 53 | ||
| 48 | 54 | - DOS/Windows/OS/2 | |
| 49 | 55 | ||
| 50 | 56 | ```dos | |
| 51 | 57 | REM e.g. if your FPC directory is located in c:\location\to\fpc: | |
| 52 | 58 | set FPCDIR=c:\location\to\fpc | |
| 53 | 59 | ``` | |
| 54 | 60 | ||
| 55 | 61 | ## Extending | |
| 56 | 62 | ||
| 57 | 63 | ### CPU/OS | |
| 58 | 64 | ||
| 59 | 65 | When adding a new operating system or CPU it's needed to extend fpcmake utility, so MAKE utility will call the proper binaries for the new target. | |
| 60 | 66 | ||
| 61 | 67 | The following types and constants needs to be extended. The arrays are declared at **fpcmmain.pp** unit. | |
| 62 | 68 | ||
| 63 | 69 | - TCpu - the enum listing all possible CPUs. A new entry needs to be added for a new CPU | |
| 64 | 70 | ||
| 65 | 71 | :* CpuStr - is the constant of representing strings for each TCPu entry | |
| 66 | 72 | ||
| 67 | 73 | :* CpuSuffix - the CPU string used as a suffix. Simply by prefixing "_" | |
| 68 | 74 | ||
| 69 | 75 | :* ppcSuffix - the CPU suffix to be used in the executable name | |
| 70 | 76 | ||
| 71 | 77 | - TOS - the num listing all operating systems | |
| 72 | 78 | ||
| 73 | 79 | :* OSStr - the constant listing representing TOS as a string. The value is used when writing a file or parsing parameters | |
| 74 | 80 | ||
| 75 | 81 | :* OSSuffix - the constant listing representing OS as a suffix | |
| 76 | 82 | ||
| 77 | 83 | - OSCpuPossible - the matrix that reflects what OS and CPU combination is possible | |
| 78 | 84 | ||
| 79 | 85 | ## See also | |
| 80 | 86 | ||
| 81 | 87 | - [Free Pascal Programmers Guide (Appendix E)](http://www.freepascal.org/docs-html/prog/progap5.html) | |
| 82 | 88 | ||
| 83 | 89 | --- | |
| 84 | 90 | *From the Free Pascal wiki, page "Fpcmake", as it stood on 2022-02-17 after a change by Unxed, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 85 | 91 | Category: FPC | |
| 86 | 92 | Category: Utilities |