Add out-of-tree module information for tizen
[platform/kernel/tizen-kernel-configs.git] / README.md
1 # Tizen Kernel config options
2
3 The config file in tizen directory of this git respostory is to be used as a
4 base for a Tizen kernel config.
5
6 All devices, targeted as a Tizen device, must have the mandatory config options
7 in `tizen_defconfig` file. While not mandatory, the recommended options in
8 `tizen_defconfig` enable advanced Tizen features and the optional config options
9 enable more features.
10
11 If you already have a minimal defconfig for your device, a possible way to
12 enable these options would be to use the `merge_config.sh` script in the kernel
13 tree. From the root of the kernel tree:
14
15 ```sh
16      ARCH=<arch> scripts/kconfig/merge_config.sh <...>/<device>_defconfig <...>/tizen-kernel-config/tizen/tizen_defconfig
17 ```
18
19 This will generate a `.config` that can then be used to save a new defconfig or
20 compile a new kernel with Tizen features enabled.
21
22 To show which module of Tizen requires these config, confgis in the
23 `tizen_defconfig` are fragmented with each module of Tizen.
24
25 This project is based on Android kernel config fragment project:
26 https://android.googlesource.com/kernel/configs