Skip to content

Commit c8f78d0

Browse files
committed
Updated BUILD.md documentation to explain and encourage the use of lua.pat.
1 parent 7e0da7d commit c8f78d0

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

BUILD.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ These tools are not strictly needed to build Lua with Open Watcom
4545
but are beneficial.
4646

4747
### Patching Utility
48-
There are a few patches for the Lua source code available,
49-
however, the patch changes are minimal
50-
and only serve to silence Watcom compiler warnings.
48+
There are a few patches for the Lua source code available.
49+
Open Watcom can build usable binaries without the patches; however,
50+
some platform-specific functionality may not be correct without them.
5151

5252
#### GNU Patch
5353
The standard patch utility on GNU systems.
@@ -84,6 +84,12 @@ to the development environment. This may include the one being built.
8484
# Building
8585
## Patch the source code for Open Watcom (optional):
8686

87+
While Open Watcom will build functional Lua interpreters without any patches,
88+
`lua.pat` includes compiler warning fixes
89+
and corrections to platform-specific behaviors missed in the upstream codebase
90+
such as DOS and OS/2 being given the Unix default package path.
91+
It is therefore highly recommended to apply the patch.
92+
8793
Depending on which patching utility is installed, run the applicable command:
8894

8995
| GNU Patch | DifPat |

0 commit comments

Comments
 (0)