RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-28 01:47:34 +00:00
Code Issues Activity Actions

Documentation: Hide Meta/serenity.sh rebuild-toolchain

Browse source 
Unless a new toolchain update has been merged, users should not need to
rebuild their toolchain. Yet, the first thing they see in the build
documentation is to run `Meta/serenity.sh rebuild-toolchain`, which
might incorrectly lead them to use it whenever they encounter an error.
This is a waste of time and causes frustration.

Move any mentions of this option to `Troubleshooting.md` and add a note
to `BuildInstructions.md` about the toolchain build being a one-time
endeavor.
This commit is contained in:
Daniel Bertalan 2023-09-17 23:36:56 +02:00 • committed by Andrew Kaster
parent 9cd3477763
commit 715f452233
4 changed files with 36 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Documentation/BuildInstructions.md
View file

@ -92,14 +92,6 @@ There is also documentation for installing the build prerequisites for some less
## Build
In order to build SerenityOS you will first need to build the toolchain by running the following command:
```console
Meta/serenity.sh rebuild-toolchain
```
Later on, when you use `git pull` to get the latest changes, there's (usually) no need to rebuild the toolchain.
Run the following command to build and run SerenityOS:
```console
@ -109,6 +101,11 @@ Meta/serenity.sh run
This will compile all of SerenityOS and install the built files into the `Build/x86_64/Root` directory inside your Git
repository. It will also build a disk image and start SerenityOS using QEMU.
The first time this command is executed, it will also download some required database files from the internet and build
the SerenityOS cross-compiler toolchain. These steps only have to be done once, so the next build will go much faster.
When we update to a newer compiler, you might be prompted to re-build the toolchain; see the [troubleshooting guide](Troubleshooting.md#the-toolchain-is-outdated)
for what to do when this happens.
If, during build, an error like `fusermount: failed to open /etc/mtab: No such file or directory` appears, you have installed `fuse2fs` but your system does not provide the mtab symlink for various reasons. Simply create this symlink with `ln -sv /proc/self/mounts /etc/mtab`.
Note that the `anon` user is able to become `root` without a password by default, as a development convenience.