aboutsummaryrefslogtreecommitdiff
path: root/docs/upgrading-webkit.md
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-02-23 17:13:30 -0800
committerGravatar GitHub <noreply@github.com> 2023-02-23 17:13:30 -0800
commitf54300578b1edc7f67daddbfae29575cbf305264 (patch)
tree1437f3274122c011f879dca71f59a74d75a33fd0 /docs/upgrading-webkit.md
parent5929daeeae1f528abab31979a0a28bc87a03b1f4 (diff)
downloadbun-f54300578b1edc7f67daddbfae29575cbf305264.tar.gz
bun-f54300578b1edc7f67daddbfae29575cbf305264.tar.zst
bun-f54300578b1edc7f67daddbfae29575cbf305264.zip
Add documentation (#2148)bun-v0.5.7
* Add documentation * Tweaks * Fixes * Rearrange * Update
Diffstat (limited to 'docs/upgrading-webkit.md')
-rw-r--r--docs/upgrading-webkit.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/upgrading-webkit.md b/docs/upgrading-webkit.md
index f9194fc15..e726fb1d8 100644
--- a/docs/upgrading-webkit.md
+++ b/docs/upgrading-webkit.md
@@ -1,5 +1,3 @@
-# Upgrading WebKit
-
Bun uses [a fork](https://github.com/oven-sh/WebKit) of WebKit with a small number of changes.
It's important to periodically update WebKit for many reasons:
@@ -9,24 +7,24 @@ It's important to periodically update WebKit for many reasons:
- Compatibility
- …and many more.
-To upgrade, first find the commit in **bun's WebKit fork** (not bun!) between when we last upgraded and now.
+To upgrade, first find the commit in **Bun's WebKit fork** (not Bun!) between when we last upgraded and now.
```bash
-cd src/bun.js/WebKit # In the WebKit directory! not bun
-git checkout $COMMIT
+$ cd src/bun.js/WebKit # In the WebKit directory! not bun
+$ git checkout $COMMIT
```
This is the main command to run:
```bash
-git pull https://github.com/WebKit/WebKit.git main --no-rebase --allow-unrelated-histories -X theirs
+$ git pull https://github.com/WebKit/WebKit.git main --no-rebase --allow-unrelated-histories -X theirs
```
Then, you will likely see some silly merge conflicts. Fix them and then run:
```bash
# You might have to run this multiple times.
-rm -rf WebKitBuild
+$ rm -rf WebKitBuild
# Go to Bun's directory! Not WebKit.
cd ../../../../