From 6ddb67dc5621c9aa97ff8a1c7188add77ef3304f Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Thu, 2 May 2024 20:11:50 +1000 Subject: [PATCH 1/5] Replicate qmk/qmk_firmware#23310 --- .clangd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.clangd b/.clangd index 2be2d817..6133ae72 100644 --- a/.clangd +++ b/.clangd @@ -1,4 +1,4 @@ CompileFlags: Add: [-Wno-unknown-attributes, -Wno-maybe-uninitialized, -Wno-unknown-warning-option] - Remove: [-W*, -mcall-prologues] + Remove: [-W*, -mmcu=*, -mcpu=*, -mfpu=*, -mfloat-abi=*, -mno-unaligned-access, -mno-thumb-interwork, -mcall-prologues] Compiler: clang From 7672002109b5856fc1b43df292bca4836fdb99d5 Mon Sep 17 00:00:00 2001 From: Vitaliy Zaytsev Date: Thu, 2 May 2024 14:20:54 +0300 Subject: [PATCH 2/5] use containerWorkspaceFolder var and pass it to setup.sh (#12) - folder name inside dev container is same as folder name on host so if it differs from qmk_userspace then setup.sh cannot be found and it sets incorrect user.overlay_dir - docs https://containers.dev/implementors/json_reference/ --- .devcontainer/devcontainer.json | 2 +- .devcontainer/setup.sh | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 2b7b817a..7aaee1fd 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -17,7 +17,7 @@ ] } }, - "postCreateCommand": "/workspaces/qmk_userspace/.devcontainer/setup.sh" + "postCreateCommand": "${containerWorkspaceFolder}/.devcontainer/setup.sh ${containerWorkspaceFolder}" // Features to add to the dev container. More info: https://containers.dev/features. // "features": {}, diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh index 25c7c5ee..9155c6cc 100755 --- a/.devcontainer/setup.sh +++ b/.devcontainer/setup.sh @@ -9,13 +9,15 @@ rm get-pip.py python3 -m pip install --upgrade milc -git config --global --add safe.directory /workspaces/qmk_userspace +userspacePath="$1" + +git config --global --add safe.directory "$userspacePath" git submodule update --init --recursive [ -d /workspaces/qmk_firmware ] || git clone https://github.com/qmk/qmk_firmware.git /workspaces/qmk_firmware git config --global --add safe.directory /workspaces/qmk_firmware qmk config user.qmk_home=/workspaces/qmk_firmware -qmk config user.overlay_dir=/workspaces/qmk_userspace +qmk config user.overlay_dir="$userspacePath" qmk git-submodule From 0f10c50b4cf01d4dad4e9d19d1655207b37fb81e Mon Sep 17 00:00:00 2001 From: arisudesu Date: Wed, 12 Jun 2024 06:00:54 +0300 Subject: [PATCH 3/5] Add `qmk config user.overlay_dir` step to README.md (#23) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 72b7d82c..9a96cbe3 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This is a template repository which allows for an external set of QMK keymaps to 1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details. 1. Fork this repository 1. Clone your fork to your local machine +1. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"` 1. Add a new keymap for your board using `qmk new-keymap` * This will create a new keymap in the `keyboards` directory, in the same location that would normally be used in the main QMK repository. For example, if you wanted to add a keymap for the Planck, it will be created in `keyboards/planck/keymaps/` * You can also create a new keymap using `qmk new-keymap -kb -km ` @@ -55,4 +56,4 @@ This can also be used to control which fork is used, though only upstream `qmk_f 1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git` 1. (To update) `git submodule update --init --recursive` -1. Commit your changes to your userspace repository \ No newline at end of file +1. Commit your changes to your userspace repository From e6f22f98b2b1b0c00d6eefa205d8a09e29d3f04f Mon Sep 17 00:00:00 2001 From: Chad Skeeters Date: Thu, 29 Aug 2024 21:27:51 -0500 Subject: [PATCH 4/5] Removes duplicated word *with* in README.md (#29) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a96cbe3..25208997 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ This is a template repository which allows for an external set of QMK keymaps to 1. Add your keymap(s) to the build by running `qmk userspace-add -kb -km ` * This will automatically update your `qmk.json` file * Corresponding `qmk userspace-remove -kb -km ` will delete it - * Listing the build targets can be done with with `qmk userspace-list` + * Listing the build targets can be done with `qmk userspace-list` 1. Commit your changes ## Howto build with GitHub From 35edec2998d4ffd2d005966537d8be431795a3aa Mon Sep 17 00:00:00 2001 From: Sergey Vlasov Date: Thu, 5 Sep 2024 11:51:35 +0300 Subject: [PATCH 5/5] Add clangd-related entries to `.gitignore` (#31) This is needed to support VS Code with clangd for userspace keymaps (in this case `compile_commands.json` and `.cache/clangd` are located in the `qmk_userspace` working copy). --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index ec5cfa2b..800a4e2c 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,8 @@ *.hex *.bin *.uf2 + +# clangd +compile_commands.json +.clangd/ +.cache/