From 0583f9d4714b26e74401a0382b4e38be6a80565b Mon Sep 17 00:00:00 2001 From: Chungmin Lee Date: Thu, 8 Jul 2021 20:06:45 +0900 Subject: [PATCH 1/2] Update README for IDE usage --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4b7e7cd4e..6ebe88f43 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,20 @@ You can use the built-in sbt shell in IntelliJ without any problems. However, th Additionally, you might have to run `sbt buildInfo` if you encounter an error like `object BuildInfo is not a member of package com.microsoft.hyperspace` for the first build. +To debug with the sbt shell in IntelliJ, run `set Test/fork := false` in the sbt shell so that the debugger attached to the sbt shell can work. Without this, breakpoints won't work. + +For a better IntelliJ and other IDE-like environment (e.g., coc.nvim) experience, try replacing symbolic links with hard links if you are in MacOS or Linux. + +```sh +$ rm spark3.1/src +$ mkdir spark3.1/src +$ git update-index --assume-unchanged spark3.1/src +$ sudo mount localhost:/src spark3.1/src # MacOS (NFS required) +$ mount --bind src spark3.1/src # Linux +``` + +With this setup, just be cautious when you do Git operations in the repository. For example, `git checkout --` will wipe out every file in `src` because Git doesn't know that essentially you've made hard links. If you want to reset source files, do `git checkout -- src` instead. + ## Inspiration and Special Thanks This project would not have been possible without the outstanding work from the following communities: From 43c7575690a5ba95940e3b55910e47748a8ec629 Mon Sep 17 00:00:00 2001 From: Chungmin Lee Date: Tue, 20 Jul 2021 01:00:48 +0900 Subject: [PATCH 2/2] Update README.md MacOs -> macOS --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6ebe88f43..f937dd92c 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ Additionally, you might have to run `sbt buildInfo` if you encounter an error li To debug with the sbt shell in IntelliJ, run `set Test/fork := false` in the sbt shell so that the debugger attached to the sbt shell can work. Without this, breakpoints won't work. -For a better IntelliJ and other IDE-like environment (e.g., coc.nvim) experience, try replacing symbolic links with hard links if you are in MacOS or Linux. +For a better IntelliJ and other IDE-like environment (e.g., coc.nvim) experience, try replacing symbolic links with hard links if you are in macOS or Linux. ```sh $ rm spark3.1/src $ mkdir spark3.1/src $ git update-index --assume-unchanged spark3.1/src -$ sudo mount localhost:/src spark3.1/src # MacOS (NFS required) +$ sudo mount localhost:/src spark3.1/src # macOS (NFS required) $ mount --bind src spark3.1/src # Linux ```