Skip to content

Commit 18e8e4f

Browse files
Update relevant documentation
1 parent 602bd4d commit 18e8e4f

3 files changed

Lines changed: 1 addition & 17 deletions

File tree

.gitattributes

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
[attr]generated linguist-generated=true diff=generated
22

3-
# Generate Cap'n Proto code
4-
compiler-core/generated/schema_capnp.rs generated
5-
63
# Tests:
74
test-package-compiler/src/generated_tests.rs generated
85

CONTRIBUTING.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -98,19 +98,6 @@ latest stable.
9898
rustup upgrade stable
9999
```
100100

101-
## Cap'n Proto schema
102-
103-
The compiler uses a Cap'n Proto schema to serialize/deserialize module information.
104-
Occasionally, the schema needs to change. After modifying `compiler-core/schema.capnp`
105-
you need to re-generate `compiler-core/generated/schema_capnp.rs`. To do that,
106-
[install Cap'n Proto](https://capnproto.org/install.html) and un-comment appropriate lines
107-
in `compiler-core/build.rs`. Then you should be able to re-generate that file with:
108-
109-
```sh
110-
cd compiler-core
111-
cargo build
112-
```
113-
114101
## Operating system specific code
115102

116103
This project is used on FreeBSD, Linux, MacOS, OpenBSD, Windows, and presumably

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ javascript-prelude-test-watch: ## Run the JavaScript prelude core tests when fil
5353

5454
.PHONY: test-watch
5555
test-watch: ## Run compiler tests when files change
56-
watchexec -e rs,toml,gleam,html,capnp "cargo test --quiet"
56+
watchexec -e rs,toml,gleam,html "cargo test --quiet"
5757

5858
.PHONY: export-hex-tarball-test
5959
export-hex-tarball-test: ## Run `gleam export hex-tarball` and verify it is created

0 commit comments

Comments
 (0)