-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e32aefa
commit b544a7d
Showing
7,974 changed files
with
2,597,948 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| Linux kernel | ||
| ============ | ||
|
|
||
| There are several guides for kernel developers and users. These guides can | ||
| be rendered in a number of formats, like HTML and PDF. Please read | ||
| Documentation/admin-guide/README.rst first. | ||
|
|
||
| In order to build the documentation, use ``make htmldocs`` or | ||
| ``make pdfdocs``. The formatted documentation can also be read online at: | ||
|
|
||
| https://www.kernel.org/doc/html/latest/ | ||
|
|
||
| There are various text files in the Documentation/ subdirectory, | ||
| several of them using the Restructured Text markup notation. | ||
|
|
||
| Please read the Documentation/process/changes.rst file, as it contains the | ||
| requirements for building and running the kernel, and information about | ||
| the problems which may result by upgrading your kernel. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| # How do I submit patches to Android Common Kernels | ||
|
|
||
| 1. BEST: Make all of your changes to upstream Linux. If appropriate, backport to the stable releases. | ||
| These patches will be merged automatically in the corresponding common kernels. If the patch is already | ||
| in upstream Linux, post a backport of the patch that conforms to the patch requirements below. | ||
| - Do not send patches upstream that contain only symbol exports. To be considered for upstream Linux, | ||
| additions of `EXPORT_SYMBOL_GPL()` require an in-tree modular driver that uses the symbol -- so include | ||
| the new driver or changes to an existing driver in the same patchset as the export. | ||
| - When sending patches upstream, the commit message must contain a clear case for why the patch | ||
| is needed and beneficial to the community. Enabling out-of-tree drivers or functionality is not | ||
| not a persuasive case. | ||
|
|
||
| 2. LESS GOOD: Develop your patches out-of-tree (from an upstream Linux point-of-view). Unless these are | ||
| fixing an Android-specific bug, these are very unlikely to be accepted unless they have been | ||
| coordinated with [email protected]. If you want to proceed, post a patch that conforms to the | ||
| patch requirements below. | ||
|
|
||
| # Common Kernel patch requirements | ||
|
|
||
| - All patches must conform to the Linux kernel coding standards and pass `script/checkpatch.pl` | ||
| - Patches shall not break gki_defconfig or allmodconfig builds for arm, arm64, x86, x86_64 architectures | ||
| (see https://source.android.com/setup/build/building-kernels) | ||
| - If the patch is not merged from an upstream branch, the subject must be tagged with the type of patch: | ||
| `UPSTREAM:`, `BACKPORT:`, `FROMGIT:`, `FROMLIST:`, or `ANDROID:`. | ||
| - All patches must have a `Change-Id:` tag (see https://gerrit-review.googlesource.com/Documentation/user-changeid.html) | ||
| - If an Android bug has been assigned, there must be a `Bug:` tag. | ||
| - All patches must have a `Signed-off-by:` tag by the author and the submitter | ||
|
|
||
| Additional requirements are listed below based on patch type | ||
|
|
||
| ## Requirements for backports from mainline Linux: `UPSTREAM:`, `BACKPORT:` | ||
|
|
||
| - If the patch is a cherry-pick from Linux mainline with no changes at all | ||
| - tag the patch subject with `UPSTREAM:`. | ||
| - add upstream commit information with a `(cherry picked from commit ...)` line | ||
| - Example: | ||
| - if the upstream commit message is | ||
| ``` | ||
| important patch from upstream | ||
| This is the detailed description of the important patch | ||
| Signed-off-by: Fred Jones <[email protected]> | ||
| ``` | ||
| >- then Joe Smith would upload the patch for the common kernel as | ||
| ``` | ||
| UPSTREAM: important patch from upstream | ||
| This is the detailed description of the important patch | ||
| Signed-off-by: Fred Jones <[email protected]> | ||
| Bug: 135791357 | ||
| Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 | ||
| (cherry picked from commit c31e73121f4c1ec41143423ac6ce3ce6dafdcec1) | ||
| Signed-off-by: Joe Smith <[email protected]> | ||
| ``` | ||
|
|
||
| - If the patch requires any changes from the upstream version, tag the patch with `BACKPORT:` | ||
| instead of `UPSTREAM:`. | ||
| - use the same tags as `UPSTREAM:` | ||
| - add comments about the changes under the `(cherry picked from commit ...)` line | ||
| - Example: | ||
| ``` | ||
| BACKPORT: important patch from upstream | ||
| This is the detailed description of the important patch | ||
| Signed-off-by: Fred Jones <[email protected]> | ||
| Bug: 135791357 | ||
| Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 | ||
| (cherry picked from commit c31e73121f4c1ec41143423ac6ce3ce6dafdcec1) | ||
| [joe: Resolved minor conflict in drivers/foo/bar.c ] | ||
| Signed-off-by: Joe Smith <[email protected]> | ||
| ``` | ||
|
|
||
| ## Requirements for other backports: `FROMGIT:`, `FROMLIST:`, | ||
|
|
||
| - If the patch has been merged into an upstream maintainer tree, but has not yet | ||
| been merged into Linux mainline | ||
| - tag the patch subject with `FROMGIT:` | ||
| - add info on where the patch came from as `(cherry picked from commit <sha1> <repo> <branch>)`. This | ||
| must be a stable maintainer branch (not rebased, so don't use `linux-next` for example). | ||
| - if changes were required, use `BACKPORT: FROMGIT:` | ||
| - Example: | ||
| - if the commit message in the maintainer tree is | ||
| ``` | ||
| important patch from upstream | ||
| This is the detailed description of the important patch | ||
| Signed-off-by: Fred Jones <[email protected]> | ||
| ``` | ||
| >- then Joe Smith would upload the patch for the common kernel as | ||
| ``` | ||
| FROMGIT: important patch from upstream | ||
| This is the detailed description of the important patch | ||
| Signed-off-by: Fred Jones <[email protected]> | ||
| Bug: 135791357 | ||
| (cherry picked from commit 878a2fd9de10b03d11d2f622250285c7e63deace | ||
| https://git.kernel.org/pub/scm/linux/kernel/git/foo/bar.git test-branch) | ||
| Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 | ||
| Signed-off-by: Joe Smith <[email protected]> | ||
| ``` | ||
|
|
||
|
|
||
| - If the patch has been submitted to LKML, but not accepted into any maintainer tree | ||
| - tag the patch subject with `FROMLIST:` | ||
| - add a `Link:` tag with a link to the submittal on lore.kernel.org | ||
| - add a `Bug:` tag with the Android bug (required for patches not accepted into | ||
| a maintainer tree) | ||
| - if changes were required, use `BACKPORT: FROMLIST:` | ||
| - Example: | ||
| ``` | ||
| FROMLIST: important patch from upstream | ||
| This is the detailed description of the important patch | ||
| Signed-off-by: Fred Jones <[email protected]> | ||
| Bug: 135791357 | ||
| Link: https://lore.kernel.org/lkml/[email protected]/ | ||
| Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 | ||
| Signed-off-by: Joe Smith <[email protected]> | ||
| ``` | ||
|
|
||
| ## Requirements for Android-specific patches: `ANDROID:` | ||
|
|
||
| - If the patch is fixing a bug to Android-specific code | ||
| - tag the patch subject with `ANDROID:` | ||
| - add a `Fixes:` tag that cites the patch with the bug | ||
| - Example: | ||
| ``` | ||
| ANDROID: fix android-specific bug in foobar.c | ||
| This is the detailed description of the important fix | ||
| Fixes: 1234abcd2468 ("foobar: add cool feature") | ||
| Change-Id: I4caaaa566ea080fa148c5e768bb1a0b6f7201c01 | ||
| Signed-off-by: Joe Smith <[email protected]> | ||
| ``` | ||
|
|
||
| - If the patch is a new feature | ||
| - tag the patch subject with `ANDROID:` | ||
| - add a `Bug:` tag with the Android bug (required for android-specific features) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| # SPDX-License-Identifier: GPL-2.0-only | ||
| menuconfig SAMPLES | ||
| bool "Sample kernel code" | ||
| help | ||
| You can build and test sample kernel code here. | ||
|
|
||
| if SAMPLES | ||
|
|
||
| config SAMPLE_AUXDISPLAY | ||
| bool "auxdisplay sample" | ||
| depends on CC_CAN_LINK | ||
|
|
||
| config SAMPLE_TRACE_EVENTS | ||
| tristate "Build trace_events examples -- loadable modules only" | ||
| depends on EVENT_TRACING && m | ||
| help | ||
| This build trace event example modules. | ||
|
|
||
| config SAMPLE_TRACE_PRINTK | ||
| tristate "Build trace_printk module - tests various trace_printk formats" | ||
| depends on EVENT_TRACING && m | ||
| help | ||
| This builds a module that calls trace_printk() and can be used to | ||
| test various trace_printk() calls from a module. | ||
|
|
||
| config SAMPLE_FTRACE_DIRECT | ||
| tristate "Build register_ftrace_direct() example" | ||
| depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m | ||
| depends on X86_64 # has x86_64 inlined asm | ||
| help | ||
| This builds an ftrace direct function example | ||
| that hooks to wake_up_process and prints the parameters. | ||
|
|
||
| config SAMPLE_TRACE_ARRAY | ||
| tristate "Build sample module for kernel access to Ftrace instancess" | ||
| depends on EVENT_TRACING && m | ||
| help | ||
| This builds a module that demonstrates the use of various APIs to | ||
| access Ftrace instances from within the kernel. | ||
|
|
||
| config SAMPLE_KOBJECT | ||
| tristate "Build kobject examples" | ||
| help | ||
| This config option will allow you to build a number of | ||
| different kobject sample modules showing how to use kobjects, | ||
| ksets, and ktypes properly. | ||
|
|
||
| If in doubt, say "N" here. | ||
|
|
||
| config SAMPLE_KPROBES | ||
| tristate "Build kprobes examples -- loadable modules only" | ||
| depends on KPROBES && m | ||
| help | ||
| This build several kprobes example modules. | ||
|
|
||
| config SAMPLE_KRETPROBES | ||
| tristate "Build kretprobes example -- loadable modules only" | ||
| default m | ||
| depends on SAMPLE_KPROBES && KRETPROBES | ||
|
|
||
| config SAMPLE_HW_BREAKPOINT | ||
| tristate "Build kernel hardware breakpoint examples -- loadable module only" | ||
| depends on HAVE_HW_BREAKPOINT && m | ||
| help | ||
| This builds kernel hardware breakpoint example modules. | ||
|
|
||
| config SAMPLE_KFIFO | ||
| tristate "Build kfifo examples -- loadable modules only" | ||
| depends on m | ||
| help | ||
| This config option will allow you to build a number of | ||
| different kfifo sample modules showing how to use the | ||
| generic kfifo API. | ||
|
|
||
| If in doubt, say "N" here. | ||
|
|
||
| config SAMPLE_KDB | ||
| tristate "Build kdb command example -- loadable modules only" | ||
| depends on KGDB_KDB && m | ||
| help | ||
| Build an example of how to dynamically add the hello | ||
| command to the kdb shell. | ||
|
|
||
| config SAMPLE_QMI_CLIENT | ||
| tristate "Build qmi client sample -- loadable modules only" | ||
| depends on m | ||
| depends on ARCH_QCOM | ||
| depends on NET | ||
| select QCOM_QMI_HELPERS | ||
| help | ||
| Build an QMI client sample driver, which demonstrates how to | ||
| communicate with a remote QRTR service, using QMI encoded messages. | ||
|
|
||
| config SAMPLE_RPMSG_CLIENT | ||
| tristate "Build rpmsg client sample -- loadable modules only" | ||
| depends on RPMSG && m | ||
| help | ||
| Build an rpmsg client sample driver, which demonstrates how | ||
| to communicate with an AMP-configured remote processor over | ||
| the rpmsg bus. | ||
|
|
||
| config SAMPLE_LIVEPATCH | ||
| tristate "Build live patching samples -- loadable modules only" | ||
| depends on LIVEPATCH && m | ||
| help | ||
| Build sample live patch demonstrations. | ||
|
|
||
| config SAMPLE_CONFIGFS | ||
| tristate "Build configfs patching sample -- loadable modules only" | ||
| depends on CONFIGFS_FS && m | ||
| help | ||
| Builds a sample configfs interface. | ||
|
|
||
| config SAMPLE_CONNECTOR | ||
| tristate "Build connector sample -- loadable modules only" | ||
| depends on CONNECTOR && HEADERS_INSTALL && m | ||
| help | ||
| When enabled, this builds both a sample kernel module for | ||
| the connector interface and a user space tool to communicate | ||
| with it. | ||
| See also Documentation/driver-api/connector.rst | ||
|
|
||
| config SAMPLE_HIDRAW | ||
| bool "hidraw sample" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
|
|
||
| config SAMPLE_PIDFD | ||
| bool "pidfd sample" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
|
|
||
| config SAMPLE_SECCOMP | ||
| bool "Build seccomp sample code" | ||
| depends on SECCOMP_FILTER && CC_CAN_LINK && HEADERS_INSTALL | ||
| help | ||
| Build samples of seccomp filters using various methods of | ||
| BPF filter construction. | ||
|
|
||
| config SAMPLE_TIMER | ||
| bool "Timer sample" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
|
|
||
| config SAMPLE_UHID | ||
| bool "UHID sample" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
| help | ||
| Build UHID sample program. | ||
|
|
||
| config SAMPLE_VFIO_MDEV_MTTY | ||
| tristate "Build VFIO mtty example mediated device sample code -- loadable modules only" | ||
| depends on VFIO_MDEV_DEVICE && m | ||
| help | ||
| Build a virtual tty sample driver for use as a VFIO | ||
| mediated device | ||
|
|
||
| config SAMPLE_VFIO_MDEV_MDPY | ||
| tristate "Build VFIO mdpy example mediated device sample code -- loadable modules only" | ||
| depends on VFIO_MDEV_DEVICE && m | ||
| help | ||
| Build a virtual display sample driver for use as a VFIO | ||
| mediated device. It is a simple framebuffer and supports | ||
| the region display interface (VFIO_GFX_PLANE_TYPE_REGION). | ||
|
|
||
| config SAMPLE_VFIO_MDEV_MDPY_FB | ||
| tristate "Build VFIO mdpy example guest fbdev driver -- loadable module only" | ||
| depends on FB && m | ||
| select FB_CFB_FILLRECT | ||
| select FB_CFB_COPYAREA | ||
| select FB_CFB_IMAGEBLIT | ||
| help | ||
| Guest fbdev driver for the virtual display sample driver. | ||
|
|
||
| config SAMPLE_VFIO_MDEV_MBOCHS | ||
| tristate "Build VFIO mdpy example mediated device sample code -- loadable modules only" | ||
| depends on VFIO_MDEV_DEVICE && m | ||
| select DMA_SHARED_BUFFER | ||
| help | ||
| Build a virtual display sample driver for use as a VFIO | ||
| mediated device. It supports the region display interface | ||
| (VFIO_GFX_PLANE_TYPE_DMABUF). | ||
| Emulate enough of qemu stdvga to make bochs-drm.ko happy. | ||
| That is basically the vram memory bar and the bochs dispi | ||
| interface vbe registers in the mmio register bar. | ||
| Specifically it does *not* include any legacy vga stuff. | ||
| Device looks a lot like "qemu -device secondary-vga". | ||
|
|
||
| config SAMPLE_ANDROID_BINDERFS | ||
| bool "Build Android binderfs example" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
| help | ||
| Builds a sample program to illustrate the use of the Android binderfs | ||
| filesystem. | ||
|
|
||
| config SAMPLE_VFS | ||
| bool "Build example programs that use new VFS system calls" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
| help | ||
| Build example userspace programs that use new VFS system calls such | ||
| as mount API and statx(). Note that this is restricted to the x86 | ||
| arch whilst it accesses system calls that aren't yet in all arches. | ||
|
|
||
| config SAMPLE_INTEL_MEI | ||
| bool "Build example program working with intel mei driver" | ||
| depends on INTEL_MEI | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
| help | ||
| Build a sample program to work with mei device. | ||
|
|
||
| config SAMPLE_WATCHDOG | ||
| bool "watchdog sample" | ||
| depends on CC_CAN_LINK | ||
|
|
||
| config SAMPLE_WATCH_QUEUE | ||
| bool "Build example watch_queue notification API consumer" | ||
| depends on CC_CAN_LINK && HEADERS_INSTALL | ||
| help | ||
| Build example userspace program to use the new mount_notify(), | ||
| sb_notify() syscalls and the KEYCTL_WATCH_KEY keyctl() function. | ||
|
|
||
| endif # SAMPLES |
Oops, something went wrong.