mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 13:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

update CONTRIBUTING.md for zig build CLI changes

Browse source
This commit is contained in:
Andrew Kelley 2021-12-03 16:17:40 -07:00
parent 7659229edc
commit 77fc9090d5
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -115,7 +115,7 @@ To quickly test a change to a file in the standard library, you can run zig test
#### Testing Non-Native Architectures with QEMU #### Testing Non-Native Architectures with QEMU
The Linux CI server additionally has qemu installed and sets `-Denable-qemu`. The Linux CI server additionally has qemu installed and sets `-fqemu`.
This provides test coverage for, e.g. aarch64 even on x86_64 machines. It's This provides test coverage for, e.g. aarch64 even on x86_64 machines. It's
recommended for Linux users to install qemu and enable this testing option recommended for Linux users to install qemu and enable this testing option
when editing the standard library or anything related to a non-native when editing the standard library or anything related to a non-native
@ -124,7 +124,7 @@ architecture.
##### glibc ##### glibc
Testing foreign architectures with dynamically linked glibc is one step trickier. Testing foreign architectures with dynamically linked glibc is one step trickier.
This requires enabling `-Denable-foreign-glibc=/path/to/glibc/multi/install/glibcs`. This requires enabling `--glibc-runtimes /path/to/glibc/multi/install/glibcs`.
This path is obtained by building glibc for multiple architectures. This This path is obtained by building glibc for multiple architectures. This
process for me took an entire day to complete and takes up 65 GiB on my hard process for me took an entire day to complete and takes up 65 GiB on my hard
drive. The CI server does not provide this test coverage. Instructions for drive. The CI server does not provide this test coverage. Instructions for
@ -136,7 +136,7 @@ It's understood that most contributors will not have these tests enabled.
#### Testing Windows from a Linux Machine with Wine #### Testing Windows from a Linux Machine with Wine
When developing on Linux, another option is available to you: `-Denable-wine`. When developing on Linux, another option is available to you: `-fwine`.
This will enable running behavior tests and std lib tests with Wine. It's This will enable running behavior tests and std lib tests with Wine. It's
recommended for Linux users to install Wine and enable this testing option recommended for Linux users to install Wine and enable this testing option
when editing the standard library or anything Windows-related. when editing the standard library or anything Windows-related.
@ -144,7 +144,7 @@ when editing the standard library or anything Windows-related.
#### Testing WebAssembly using wasmtime #### Testing WebAssembly using wasmtime
If you have [wasmtime](https://wasmtime.dev/) installed, take advantage of the If you have [wasmtime](https://wasmtime.dev/) installed, take advantage of the
`-Denable-wasmtime` flag which will enable running WASI behavior tests and std `-fwasmtime` flag which will enable running WASI behavior tests and std
lib tests. It's recommended for all users to install wasmtime and enable this lib tests. It's recommended for all users to install wasmtime and enable this
testing option when editing the standard library and especially anything testing option when editing the standard library and especially anything
WebAssembly-related. WebAssembly-related.