Skip to content

Commit 2ed1887

Browse files
committed
Update OtherTools page
1 parent 3489db4 commit 2ed1887

2 files changed

Lines changed: 20 additions & 15 deletions

File tree

src/OtherTools.asciidoc

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,53 @@
11
:doctitle: Other Tools Developed Here
2+
:sectnums:
3+
:toc: left
4+
:toclevels: 4
25

3-
Subdirectory source/tools/ inside link:index[PasDoc] sources
6+
## Introduction
7+
8+
Subdirectory `source/tools/` inside link:index[PasDoc] sources
49
contains some useful programs related to PasDoc. They are either small
510
programs helpful for development of PasDoc, or tools that use PasDoc
611
units to do other tasks.
712

813
## [[file_to_pascal_string]] file_to_pascal_string
914

10-
Converts any text file into a Pascal string, so that you can compile
11-
text files inside your program.
15+
Converts any text file into a Pascal string.
16+
This allows to embed contents of any text file into a compiled program.
1217

1318
## [[file_to_pascal_data]] file_to_pascal_data
1419

15-
Converts any file into a Pascal array of bytes, so that you can compile
16-
binary files inside your program.
20+
Converts any file into a Pascal array of bytes.
21+
This allows to embed contents of any binary file into a compiled program.
1722

1823
## [[pascal_pre_proc]] pascal_pre_proc
1924

20-
Pascal preprocessor. It reads the Pascal source file given on the
25+
Pascal preprocessor. Rreads the Pascal source file given on the
2126
command-line, and outputs it's processed version to the standard output.
2227
Features (all inherited from pasdoc tokenizer and scanner):
2328

24-
* Handles $ifdef and related constructs
29+
* Handles `$ifdef` and related constructs, see link:ConditionalDefines[conditional expressions support].
2530
2631
* Handles FPC macros (very useful if you want to use FPC source code using macros in Delphi)
27-
* Handles $include
32+
33+
* Handles `$include`
34+
2835
* Preserves whitespace
2936
3037
The preprocessor behavior can be configured by a couple of command-line
3138
options, a subset of link:CommandLine[PasDoc command line options].
32-
Run pascal_pre_proc --help to get a list of supported options. Examples
39+
Run `pascal_pre_proc --help` to get a list of supported options. Examples
3340
of use:
3441

3542
* Basic test of handling macros using ok_macros.pas file from pasdoc tests:
3643
+
3744
----
3845
pascal_pre_proc pasdoc/tests/ok_macros.pas
3946
----
40-
* Generate a single (without any $includes and $ifdefs) source code of the SysUtils unit for Linux/i386 target from FPC sources:
47+
* Generate a single (without any `$include`, `$ifdef` etc.) source code of the SysUtils unit for Linux/i386 target from FPC sources:
4148
+
4249
----
4350
pascal_pre_proc unix/sysutils.pp \
4451
-I objpas/sysutils/ -I inc/ -I i386/ -I ./linux/ \
4552
-D UNIX -D cpui386 > linux_i386_sysutils.pas
4653
----
47-
+
48-
Note that this is not perfect. because proper handling of $if and $elseif conditions is not implemented yet.

src/index.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,10 @@ In short, just call
118118
----
119119
git clone https://github.com/pasdoc/pasdoc.git
120120
----
121-
* See link:CompilingPasDoc[CompilingPasDoc] for instructions how to compile PasDoc.
122-
* See link:ReleaseMaking[ReleaseMaking] to know how we test and package PasDoc for final releases.
121+
* See link:CompilingPasDoc[compiling PasDoc] for instructions how to compile PasDoc.
122+
* See link:ReleaseMaking[release making] to know how we test and package PasDoc for final releases.
123123
124-
While developing PasDoc we also developed some link:OtherTools[OtherTools] that you may find useful.
124+
While developing PasDoc we also developed some link:OtherTools[other tools, like Pascal preprocessor] that you may find useful.
125125

126126
About these web pages:
127127

0 commit comments

Comments
 (0)