kernel_linux_common_modules/README.md

kernel_linux_common_modules

介绍

仓用途：为Linux内核通用模块放置仓，为各内核领域公共仓。该仓不提供任何特性或能力，仅为集中容纳各内核独立模块，方便内核仓管理。 适用模块：通用内核模块，可在OpenHarmony支持的任何Linux内核版本上使用。对特定平台或硬件等依赖的模块不适合合入该仓。

目录结构

kernel/linux/
       └ ─ ─  common_modules/
                  ├ ─ ─  xxx/                        # xxx内核独立模块目录
                  │       ├ ─ ─  include/            # 模块头文件目录，可自定义
                  │       ├ ─ ─  src/                # 模块源文件目录，可自定义
                  │       ├ ─ ─  README.OpenSource   # 模块资源配置文件
                  │       ├ ─ ─  README.md           # 模块自简介文件
                  │       └ ─ ─  README_en.md
                  ├ ─ ─  yyy/                        # yyy内核独立模块目录
                  ├ ─ ─  LICENSE                     # 许可配置文件，合入模块同步更新
                  ├ ─ ─  OAT.xml                     # OAT扫描配置文件，合入模块同步更新
                  ├ ─ ─  README.md                   # linux内核通用模块仓介绍文档
                  └ ─ ─  README_en.md

贡献流程

1. 以模块特性为名新建仓下新目录，合入代码并提交。
2. 更新OAT和license文件。
3. 申请内核SIG会议进行评审。
4. 评审通过由内核SIG committer审核合入，未评审通过可解决遗留问题再次上会评审，或评审不适合该仓则放弃合入。
5. 内核SIG会议申请流程详见kernel_sig community 。

提交指导参考

1. 【LICENSE】由于该仓下都为Linux模块，统一使用GPL系列协议，可参考NewIP添加如下：

  Copyright (c) 2023 Huawei Device Co., Ltd. All rights reserved.

+ The newip subdirectories is licensed under GPL-2.0+.

  a) Valid-License-Identifier: GPL-2.0

2. 【OAT】OAT为OpenHarmony社区的自动化开源审视工具，OAT.xml本仓扫描规则，各模块文件规则不一，模块上库时需更新已有OAT.xml文档，具体修改方法请参考OAT tool README 。
3. 【构建】当前内核树外模块可以通过软链接的方式参与内核构建，可由模块目录下独立脚本执行完成动态软链接创建，可参考NewIP软链接创建脚本 。
4. 【模块README】模块目录下提供介绍文件。文件需包含模块功能说明、架构目录说明、使用说明、构建说明、相关依赖仓说明等。文档模板，可参考NewIP README文件 。
5. 【README.OpenSource】如本模块借鉴或使用某一开源软件则需要配置该文件，该文件描述被借鉴软件的信息，以NewIP（借鉴Linux下IPv4 IPv6协议）为例进行说明如下：

[
    {
        "Name": "linux-5.10",              # 借鉴或使用的软件名，
        "License": "GPL-2.0+",             # 使用的许可
        "License File": "COPYING",         # 许可所在文件
        "Version Number": "5.10.93",       # 借鉴时该软件的版本
        "Owner": "xxx@xxx.com",            # 借鉴软件引入及拥有人邮箱
        "Upstream URL": "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/log/?h=linux-5.10.y",   # 借鉴软件开源地址链接
        "Description": "linux kernel 5.10" # 对借鉴的开源软件模块的描述
    }
]

合入检视规则

1. 【规则】合入该仓模块在构建及运行时只能正向依赖内核，不得产生反向依赖。
2. 【规则】合入时同步提供可编译方案，不可仅代码上库。模块可以通过构建和config配置选择参与版本构建，以适应不同形态产品内核模块的可选择性需求。
3. 【规则】该仓为内核通用模块仓，合入模块不可依赖于特定芯片平台、产品、硬件等。
4. 【规则】该仓使用GPL系列协议，新增模块需要配置仓LICENSE文件。
5. 【规则】合入模块需更新OAT文件，并完成合入模块OAT扫描，评审时提供扫描报告。
6. 【规则】合入模块需在该仓下创建独立目录，同时模块目录下同步提交README文件。
7. 【规则】合入模块如有借鉴或使用三方开源模块的需要提供README.OpenSource文件。
8. 【建议】具备编译ko的条件，在ko构建能力上线后可适配整改构建出ko模块。