aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorColin Cross <ccross@android.com>2018-07-09 09:44:41 -0700
committerColin Cross <ccross@android.com>2018-07-09 20:14:11 +0000
commitaa070b422e5148b61cd146c40f6224822e11935c (patch)
treedfafbe92a17c291c8606a846d16a470d774bd2f8
parent17ef5635fa1b81a0aa41f6ad094afc740444db36 (diff)
downloadbuild_soong-aa070b422e5148b61cd146c40f6224822e11935c.tar.gz
build_soong-aa070b422e5148b61cd146c40f6224822e11935c.tar.bz2
build_soong-aa070b422e5148b61cd146c40f6224822e11935c.zip
Document build/soong/scripts/setup_go_workspace_for_soong.sh
Test: none Change-Id: I507b7118bfc240166dced0cc26ab523ce56f68a2
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3549b025..9f427c4c 100644
--- a/README.md
+++ b/README.md
@@ -217,6 +217,18 @@ See [art/build/art.go](https://android.googlesource.com/platform/art/+/master/bu
or [external/llvm/soong/llvm.go](https://android.googlesource.com/platform/external/llvm/+/master/soong/llvm.go)
for examples of more complex conditionals on product variables or environment variables.
+## Developing for Soong
+
+To load Soong code in a Go-aware IDE, create a directory outside your android tree and then:
+```bash
+apt install bindfs
+export GOPATH=<path to the directory you created>
+build/soong/scripts/setup_go_workspace_for_soong.sh
+```
+
+This will bind mount the Soong source directories into the directory in the layout expected by
+the IDE.
+
## Contact
Email android-building@googlegroups.com (external) for any questions, or see