aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Willemsen2017-11-08 18:39:18 -0600
committerDan Willemsen2017-11-28 16:19:50 -0600
commit773386251d2460576916a305cd1762581bff1a0b (patch)
treeaef62ae6b4ce53680610c218e72483319d0cd9a9 /README.md
parentadbaeb0c1db1d3fdb00d937f3a6057e20b1877df (diff)
downloadplatform-build-773386251d2460576916a305cd1762581bff1a0b.tar.gz
platform-build-773386251d2460576916a305cd1762581bff1a0b.tar.xz
platform-build-773386251d2460576916a305cd1762581bff1a0b.zip
Mark envsetup.sh vars as deprecated in makefiles
For the envsetup.sh variables that should not be used in makefiles (since they're not explicitly set up, and won't be available on the build servers), mark them as deprecated. Rework our documentation to have a landing page, and create a "Changes" section where we can record changes like these. At some point I may go and backfill some recent work. Test: build/soong/build_test.bash Change-Id: I54b9294ddf270245afdb58d17150db8098584e8a
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..47809a95a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
1# Android Make Build System
2
3This is the Makefile-based portion of the Android Build System.
4
5For documentation on how to run a build, see [Usage.txt](Usage.txt)
6
7For a list of behavioral changes useful for Android.mk writers see
8[Changes.md](Changes.md)
9
10For an outdated reference on Android.mk files, see
11[build-system.html](/core/build-system.html). Our Android.mk files look similar,
12but are entirely different from the Android.mk files used by the NDK build
13system. When searching for documentation elsewhere, ensure that it is for the
14platform build system -- most are not.
15
16This Makefile-based system is in the process of being replaced with [Soong], a
17new build system written in Go. During the transition, all of these makefiles
18are read by [Kati], and generate a ninja file instead of being executed
19directly. That's combined with a ninja file read by Soong so that the build
20graph of the two systems can be combined and run as one.
21
22[Kati]: https://github.com/google/kati
23[Soong]: https://android.googlesource.com/platform/build/soong/+/master