From 63359046c546730c957019b6344d7ef376851006 Mon Sep 17 00:00:00 2001 From: lizzie Date: Mon, 4 Aug 2025 08:56:41 +0100 Subject: [PATCH 1/2] [docs] IDE setup for vscode, better wording in guideline Signed-off-by: lizzie --- docs/Development.md | 29 ++++++++++++++++++++++++----- src/dynarmic/README.md | 2 -- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/docs/Development.md b/docs/Development.md index 541b1209ab..a92ff8bfc2 100644 --- a/docs/Development.md +++ b/docs/Development.md @@ -33,18 +33,37 @@ Pull requests are only to be merged by core developers when properly tested and [desktop] feat: implement firmware install from ZIP [hle] stub fw20 functions [core] test: raise maximum CPU cores to 6 +[cmake, core] Unbreak FreeBSD Building Process ``` -The level of namespacing is generally left to the committer's choice, but we never recommend going more than two levels *except* in `hle`, in which case you may go as many as four levels depending on the specificity of your changes. Developers are permitted to change namespaces at will. Commits within PRs are not required to be namespaced, but it is highly recommended. +The level of namespacing is generally left to the committer's choice, but we never recommend going more than two levels *except* in `hle`, in which case you may go as many as four levels depending on the specificity of your changes. Ocassionally up to two namespaces may be provided for more clarity. Developers are permitted to change namespaces at will. Commits within PRs are not required to be namespaced, but it is highly recommended. -# Building speedup +# IDE setup + +## VSCode +Copy this to `.vscode/settings.json`, get CMake tools and it should be ready to build: +```json +{ + "editor.tabSize": 4, + "files.watcherExclude": { + "**/target": true + }, + "files.associations": { + "*.inc": "cpp" + }, + "git.enableCommitSigning": true, + "git.alwaysSignOff": true +} +``` + +# Build speedup If you have an HDD, use ramdisk (build in RAM): ```sh sudo mkdir /tmp/ramdisk sudo chmod 777 /tmp/ramdisk -# about 10GB needed -sudo mount -t tmpfs -o size=10G myramdisk /tmp/ramdisk +# about 8GB needed +sudo mount -t tmpfs -o size=8G myramdisk /tmp/ramdisk cmake -B /tmp/ramdisk cmake --build /tmp/ramdisk -- -j32 sudo umount /tmp/ramdisk @@ -88,7 +107,7 @@ For more information type `info gdb` and read [the man page](https://man7.org/li Since going into the past can be tricky (especially due to the dependencies from the project being lost thru time). This should "restore" the URLs for the respective submodules. ```sh -#!/bin/sh +#!/bin/sh -e cat > .gitmodules < Date: Mon, 4 Aug 2025 12:48:01 -0400 Subject: [PATCH 2/2] clarity Signed-off-by: crueter --- docs/Development.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/Development.md b/docs/Development.md index a92ff8bfc2..c28c3aa32e 100644 --- a/docs/Development.md +++ b/docs/Development.md @@ -36,7 +36,12 @@ Pull requests are only to be merged by core developers when properly tested and [cmake, core] Unbreak FreeBSD Building Process ``` -The level of namespacing is generally left to the committer's choice, but we never recommend going more than two levels *except* in `hle`, in which case you may go as many as four levels depending on the specificity of your changes. Ocassionally up to two namespaces may be provided for more clarity. Developers are permitted to change namespaces at will. Commits within PRs are not required to be namespaced, but it is highly recommended. +- The level of namespacing is generally left to the committer's choice. +- However, we never recommend going more than two levels *except* in `hle`, in which case you may go as many as four levels depending on the specificity of your changes. +- Ocassionally, up to two namespaces may be provided for more clarity. + * Changes that affect the entire project (sans CMake changes) should be namespaced as `meta`. +- Maintainers are permitted to change namespaces at will. +- Commits within PRs are not required to be namespaced, but it is highly recommended. # IDE setup @@ -56,6 +61,8 @@ Copy this to `.vscode/settings.json`, get CMake tools and it should be ready to } ``` +You may additionally need the `Qt Extension Pack` extension if building Qt. + # Build speedup If you have an HDD, use ramdisk (build in RAM): -- 2.39.5