diff options
author | Elliott Hughes <enh@google.com> | 2017-07-24 19:31:04 +0000 |
---|---|---|
committer | android-build-merger <android-build-merger@google.com> | 2017-07-24 19:31:04 +0000 |
commit | 32722d7781bb5df999eea1b288c9f5338a542d27 (patch) | |
tree | eb5e0273ea995c3d9b3dcce3b86c36fa98213929 | |
parent | 3d5032f6a22aa4c6de0000400379c4ccccbe31bd (diff) | |
parent | 284ad73b3b8e709102d9e98b1232065f160926cc (diff) | |
download | kernel-headers-32722d7781bb5df999eea1b288c9f5338a542d27.tar.gz |
Merge "Update the kernel-headers docs." am: ab0b76f533
am: 284ad73b3b
Change-Id: I95091516df56b97fb1eac326352d72e6c3ec1271
-rw-r--r-- | README.md | 46 | ||||
-rw-r--r-- | modified/README.TXT | 14 | ||||
-rw-r--r-- | modified/scsi/README.TXT | 14 | ||||
-rw-r--r-- | original/README.TXT | 47 |
4 files changed, 46 insertions, 75 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f46af1 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +Android kernel headers +====================== + +This project contains the original kernel headers that are used to generate +Bionic's "cleaned-up" user-land headers. + +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. + +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 +[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 +------------------------- +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 +into bionic. The generation script will indicate if these files have +changed and require another manual update. + +The files from the scsi directory will be copied into bionic after +being processed as is, unless there exists a file of the same name in +`../modified/scsi`. Any files found in the modified directory completely +replace the ones in the scsi directory. diff --git a/modified/README.TXT b/modified/README.TXT deleted file mode 100644 index 612c6b5..0000000 --- a/modified/README.TXT +++ /dev/null @@ -1,14 +0,0 @@ -This directory contains kernel headers that must be modified by hand -before they are used to generate Bionic's "cleaned-up" user-land headers. - -Currently this includes scsi/scsi.h from 3.18, which mixes userspace-facing -and kernel-facing definitions even after the uapi cleanup. - -They are mostly covered by the GPLv2 + exception, and thus cannot be -distributed as part of the platform itself. -(NOTE: 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. - -For more details, please read bionic/libc/kernel/README.TXT. diff --git a/modified/scsi/README.TXT b/modified/scsi/README.TXT deleted file mode 100644 index 612c6b5..0000000 --- a/modified/scsi/README.TXT +++ /dev/null @@ -1,14 +0,0 @@ -This directory contains kernel headers that must be modified by hand -before they are used to generate Bionic's "cleaned-up" user-land headers. - -Currently this includes scsi/scsi.h from 3.18, which mixes userspace-facing -and kernel-facing definitions even after the uapi cleanup. - -They are mostly covered by the GPLv2 + exception, and thus cannot be -distributed as part of the platform itself. -(NOTE: 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. - -For more details, please read bionic/libc/kernel/README.TXT. diff --git a/original/README.TXT b/original/README.TXT deleted file mode 100644 index 160ef81..0000000 --- a/original/README.TXT +++ /dev/null @@ -1,47 +0,0 @@ -This directory contains the original kernel headers that are used to generate -Bionic's "cleaned-up" user-land headers. - -They are mostly covered by the GPLv2 + exception, and thus cannot be -distributed as part of the platform itself. -(NOTE: 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. - -For more details, please read bionic/libc/kernel/README.TXT. - -Generated Headers ------------------ -The uapi directory contains uapi version of original kernel 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. - -The headers are mostly covered by the GPLv2 + exception, and thus cannot be -distributed as part of the platform itself. -(NOTE: The cleaned up headers do not contain copyrightable information and -are distributed with Bionic) - -For more details, please read bionic/libc/kernel/README.TXT - -Manually Modified Headers -------------------------- -The scsi directory contains a set of manually updated headers. The scsi kernel -header were never properly made to into uapi versions, so this directory -contains the unmodified scsi headers that are imported into bionic. The -generation script will indicate if these files have changed and require -another manual update. - -The files from the scsi directory will be copied into bionic after being -processed as is, unless there exists a file of the same name in -../modified/scsi. Any files found in the modified directory completely -replace the ones in the scsi directory. |