diff options
| author |  Colin McDonnell <colinmcd94@gmail.com>
| 2023-07-06 13:02:29 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-07-06 13:02:29 -0700 |
| commit | 109ebc14fda92bc2c84459b9911bef03b08f1b0a (patch) | |
| tree | af707758802715fcb567ac88225e0c23e2974dbd /docs/project/development.md | |
| parent | 95ddfcc4377350b1d604c39c36562bde45fad2a9 (diff) | |
| download | bun-109ebc14fda92bc2c84459b9911bef03b08f1b0a.tar.gz bun-109ebc14fda92bc2c84459b9911bef03b08f1b0a.tar.zst bun-109ebc14fda92bc2c84459b9911bef03b08f1b0a.zip | |
Various docs updates (#3437)
* Various docs updates
* Add mocks page
* Fix make
* WebKit instructions
* Update instructions
* Updates
* Update nodejs compat table
* Document trusted deps
* Tweak trustedDependencies docs
* Document --exact
* Update test docs
* Tweaks
* Boring
* Remove redundant j
* Undo makefile changes
* Undo makefile changes
* Update page title
* Regen
* Undo changes
Diffstat (limited to 'docs/project/development.md')
| -rw-r--r-- | docs/project/development.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/project/development.md b/docs/project/development.md index d21641aff..e50f53215 100644 --- a/docs/project/development.md +++ b/docs/project/development.md @@ -217,6 +217,37 @@ You'll need a very recent version of Valgrind due to DWARF 5 debug symbols. You $ valgrind --fair-sched=try --track-origins=yes bun-debug <args> ``` +## Updating `WebKit` + +The Bun team will occasionally bump the version of WebKit used in Bun. When this happens, you may see something like this with you run `git status`. + +```bash +$ git status +On branch my-branch +Changes not staged for commit: + (use "git add <file>..." to update what will be committed) + (use "git restore <file>..." to discard changes in working directory) + modified: src/bun.js/WebKit (new commits) +``` + +For performance reasons, `bun submodule update` does not automatically update the WebKit submodule. To update, run the following commands from the root of the Bun repo: + +```bash +$ bun install +$ make bindings +``` + +<!-- Check the [Bun repo](https://github.com/oven-sh/bun/tree/main/src/bun.js) to get the hash of the commit of WebKit is currently being used. + +{% image width="270" src="https://github.com/oven-sh/bun/assets/3084745/51730b73-89ef-4358-9a41-9563a60a54be" /%} --> + +<!-- +```bash +$ cd src/bun.js/WebKit +$ git fetch +$ git checkout <hash> +``` --> + ## Troubleshooting ### libarchive |