summaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
2021-07-13Documentation: Make sure Windows have QEMU tools in their WSL2 systemGunnar Beutner
They don't need QEMU to run the VM but they do at least need the QEMU tools to build the image.
2021-07-12Meta+CI: Use wabt version 1.0.23 for all CI jobsAndrew Kaster
The WASM spec tests caused a stack overflow when generated with wat2wasm version 1.0.23, which ships with homebrew. To give feature parity, manually download the same version from GitHub packages for Ubuntu. Document the dependencies of the WASM spec tests option, as well.
2021-07-12Documentation: Condense the Windows build instructions some moreGunnar Beutner
2021-07-12Documentation: Remove obsolete CMake optionGunnar Beutner
2021-07-12Documentation: Show users how to build specific ninja targets directlyGunnar Beutner
2021-07-12Documentation: Shuffle around systems in the build instruction docsGunnar Beutner
The crowd has spoken and it's clear they want... Windows and Arch Linux.
2021-07-12Meta+Documentation: Remove unused -DDEBUG from buildAndrew Kaster
2021-07-10Documentation: Move the QEMU troubleshooting sectionGunnar Beutner
This is no longer relevant for most users because due to an unrelated change to Meta/run.sh the default display backend is now SDL which does not exhibit this problem.
2021-07-10Documentation: Add screenshot for WHPXGunnar Beutner
2021-07-10Documentation+Meta: Automatically add disable_virtio on WindowsGunnar Beutner
2021-07-10Documentation+Meta: Automatically set vmx=off on WindowsGunnar Beutner
2021-07-10Documentation: Remove another redundant chapterGunnar Beutner
Clearly nobody has used this in a while because cpuinfo.c for GCC 11 does not contain the code that's mentioned here.
2021-07-10Documentation: Remove redundant informationGunnar Beutner
These workarounds are already mentioned in the "Hardware acceleration" section.
2021-07-10Documentation: Suggest using x86_64 QEMU on WindowsGunnar Beutner
The x86_64 QEMU binary supports both i386 as well as x86_64 guests. By using the x86_64 binary users won't have to change anything when switching between i386 and x86_64 builds.
2021-07-10Meta: Automatically use WSL paths on WindowsGunnar Beutner
2021-07-10Documentation: Reorganize the build documentationGunnar Beutner
2021-07-09Documentation: Add a package manager section to the FAQnetworkException
People are commonly asking about a package manager in serenity. This patch adds an answer the FAQ, explaining why there is no need for packages as well as different possible ways to add or remove software installed on the system.
2021-07-09Documentation: Added build instructions for Void LinuxYori
2021-07-09Kernel: Stop booting and print if PAE is not supported by the processorLuke
We currently require PAE and not having it causes us to crash. This turns that crash into an error message.
2021-07-07Documentation: Add simple troubleshooting guideLiav A
In this guide, we explain two boot errors that can occur and what can be done to solve them.
2021-07-06Documentation: Document the ConfigureComponents utilityMax Wipfli
This adds documentation for the ConfigureComponents utility to the build instructions.
2021-07-03Documentation: Add git to the list of self-hosted runner requirementsIdan Horowitz
Github-hosted runners have this pre-installed, so our actions script do not install it themselves.
2021-07-03Documentation: Increase recommended amount of RAMGunnar Beutner
The VM won't boot with 32MB because GRUB won't be able to load the kernel which is about 114MB.
2021-07-03Documentation: Update VirtualBox documentation for x86_64Gunnar Beutner
The machine type "Other/Unknown (64-bit)" works for both the x86_64 as well as the i686 build architecture.
2021-07-03Documentation: Add instructions for setting up self-hosted runnersIdan Horowitz
2021-07-03Documentation: Add workaround for blackscreen using WSL+QEMU6.xTristan Menke
This workaround disables the in-kernel interrupt controller. This impacts the VM performance and should probably be removed when the workaround is no longer needed. This workaround was posed by stelar7. See #7523
2021-07-03Documentation: Add notes for first time setup of the project in CLionDiego Garza
Mention the "Open Project Wizard" where you can set the CMake options before making the cache. Remind users to use the "Default" build type and to build the Toolchain so CMake does not complain.
2021-06-29Documentation: Document changes to creating smart pointersDaniel Bertalan
Because of the added complexity of *non-throwing* `new`, helper methods for correctly constructing smart pointers were added in a previous commit. This commit changes the documentation to recommend using these, and adds examples to aid in correctly determining when to use non-throwing new when manually creating smart pointers.
2021-06-18Documentation/WSL: add a workaround for slow emulation on HiDPI screensStéphane Travostino
2021-06-17Meta: Add support for declaring componentsGunnar Beutner
Components are a group of build targets that can be built and installed separately. Whether a component should be built can be configured with CMake arguments: -DBUILD_<NAME>=ON|OFF, where <NAME> is the name of the component (in all caps). Components can be marked as REQUIRED if they're necessary for a minimally functional base system or they can be marked as RECOMMENDED if they're not strictly necessary but are useful for most users. A component can have an optional description which isn't used by the build system but may be useful for a configuration UI. Components specify the TARGETS which should be built when the component is enabled. They can also specify other components which they depend on (with DEPENDS). This also adds the BUILD_EVERYTHING CMake variable which lets the user build all optional components. For now this defaults to ON to make the transition to the components-based build system easier. The list of components is exported as an INI file in the build directory (e.g. Build/i686/components.ini). Fixes #8048.
2021-06-13Documentation: Move Ubuntu/Debian specific build instructionsAdam Hodgen
Ubuntu/Debian specific instructions should live under the Ubuntu/Debian header
2021-06-13Documentation: Fix QEMU 5 Ubuntu version confusionAdam Hodgen
PR #7970 added a line clarifying the requirement for QEMU 5. Unfortunately, this location this line was added changed the meaning of the following line, referencing the availability of GCC in Ubuntu 20.04. QEMU 5 is not available in Ubuntu 20.04, so this change is incorrect, as well as misleading.
2021-06-10Kernel: Add driver for RTL8168 & RTL8111 NICsIdan Horowitz
These are pretty common on older LGA1366 & LGA1150 motherboards. NOTE: Since the registers datasheets for all versions of the chip besides versions 1 - 3 are still under NDAs i had to collect several "magical vendor constants" from the *BSD driver and the linux driver that i was not able to name verbosely, and as such these are labeled with the comment "vendor magic values".
2021-06-10Documentation: Specify minimum required QEMU versionApoorv Mishra
2021-06-09Documentation: Add a list of supported network cardsLiav A
2021-06-07Documentation: Add ccache and rsync to the packages to installGunnar Beutner
These aren't hard dependencies but make building and working with SerenityOS significantly faster.
2021-06-06Documentation: Remove redundancy in CodingStyle.mdkemzeb
This is a fairly small change; removed the statement "Pointer and reference types in C++ code" as it does not provide any additional knowledge that contributors are or will be aware of after further reading into the "Pointers and References" section. It seems unnecessary and redundant given the sentence adjacent to it.
2021-06-04Documentation: Fix a typo by removing an extra wordScott Antipa
2021-06-02Documentation: Correct some typos in kernel and browser docsSiddhant Rao
2021-06-01Documentation: Add rule about "east const" to CodingStyle.mdAndreas Kling
Unfortunately we cannot enforce this with clang-format yet, as that feature is not available. Until then, let's try to write new code with this in mind, and convert old code as we go.
2021-05-31Documentation: Add explanation about AHCI lockingLiav A
2021-05-31Documentation: Remove outdated info about `pls` from build instructionsAndreas Kling
2021-05-29Userland: Check sudoers file perms and owner in plsJesse Buhagiar
As per comment found in #6319 by @bcoles, `pls` should check the permissions and owner of the sudoers file to ensure that it hasn't been compromised.
2021-05-29Userland: Implement `pls`, a sudo cloneJesse Buhagiar
2021-05-29Meta: Add `binutils-devel` to fedora build docsJacob Lindgren
2021-05-29Documentation: Add another working laptop model to the listLiav A
2021-05-27Meta/CI: Add ENABLE_ALL_DEBUG_FACILITIES CMake optionAndrew Kaster
This option replaces the use of ENABLE_ALL_THE_DEBUG_MACROS in CI runs, and enables all debug options that might be broken by developers unintentionally that are only used in specific debugging situations.
2021-05-27Kernel: Add ENABLE_EXTRA_KERNEL_DEBUG_SYMBOLS option to set Og and ggdb3Andrew Kaster
When debugging kernel code, it's necessary to set extra flags. Normal advice is to set -ggdb3. Sometimes that still doesn't provide enough debugging information for complex functions that still get optimized. Compiling with -Og gives the best optimizations for debugging, but can sometimes be broken by changes that are innocuous when the compiler gets more of a chance to look at them. The new CMake option enables both compile options for kernel code.
2021-05-21LibWasm+Meta: Add test-wasm and optionally test the conformance testsAli Mohammad Pur
This only tests "can it be parsed", but the goal of this commit is to provide a test framework that can be built upon :) The conformance tests are downloaded, compiled* and installed only if the INCLUDE_WASM_SPEC_TESTS cmake option is enabled. (*) Since we do not yet have a wast parser, the compilation is delegated to an external tool from binaryen, `wasm-as`, which is required for the test suite download/install to succeed. This *does* run the tests in CI, but it currently does not include the spec conformance tests.
2021-05-17Everywhere: Fix a bunch of typosLinus Groh