aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElliott Hughes <enh@google.com>2019-04-11 15:53:39 -0700
committerandroid-build-merger <android-build-merger@google.com>2019-04-11 15:53:39 -0700
commitd5954d0d4f78a6d24cf45d917bae0f43d1dc1ca9 (patch)
tree995ad8442ba9738dd070fe728c5bbb225fc5ab4f
parent05215268d71368ebeab8238a512124cda35491a7 (diff)
parent9b2106519913afb0307bcbc7ea69e8948cff31a1 (diff)
downloadkernel-headers-d5954d0d4f78a6d24cf45d917bae0f43d1dc1ca9.tar.gz
Merge "Update the docs slightly." am: 3631e25e50
am: 9b21065199 Change-Id: I086c27be08211cfc07c5b1861253c1733079e6dc
-rw-r--r--README.md35
1 files changed, 11 insertions, 24 deletions
diff --git a/README.md b/README.md
index 4f46af1..0ea8a38 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-Android kernel headers
-======================
+# Android kernel headers
This project contains the original kernel headers that are used to generate
Bionic's "cleaned-up" user-land headers.
@@ -8,32 +7,20 @@ They are mostly covered by the GPLv2 + exception, and thus cannot be
distributed as part of the platform itself. The cleaned up headers do not
contain copyrightable information and are distributed with bionic.
-Importing modified kernel headers files is done using scripts found in bionic.
+## Regenerating the bionic headers
Note that if you're actually just trying to expose device-specific headers
-to build your device drivers, you shouldn't modify bionic. Instead
-use `TARGET_DEVICE_KERNEL_HEADERS` and friends described in
+to build your device drivers, you shouldn't modify these headers or bionic.
+Instead use `TARGET_DEVICE_KERNEL_HEADERS` and friends as described in
[config.mk](https://android.googlesource.com/platform/build/+/master/core/config.mk#186).
-Regenerating the bionic headers
--------------------------------
-The uapi directory contains the original kernel UAPI (userspace API) headers
-that are used to generate Bionic's "cleaned-up" user-land headers. The script
-`bionic/libc/kernel/tools/generate_uapi_headers.sh` automatically imports the
-headers from an android kernel repository.
-
-Running the script:
-```
-generate_uapi_headers.sh --download-kernel
-```
-
-In order to run the script, you must have properly initialized the build
-environment using the lunch command. The script will automatically retrieve
-an android kernel, generate all include files, and then copy the headers to
-this directory.
-
-Manually modified headers
--------------------------
+Otherwise see the
+[bionic/libc/kernel docs](https://android.googlesource.com/platform/bionic/+/master/libc/kernel/)
+for how to actually take an update.
+
+
+## Manually modified headers
+
The `modified/scsi` directory contains a set of manually updated headers.
The scsi kernel headers were never properly made to into uapi versions,
so this directory contains the unmodified scsi headers that are imported