From 43adffee4cdc35f3e311ff3b27de82455f4cb273 Mon Sep 17 00:00:00 2001 From: chenmaodong Date: Tue, 3 Jan 2023 14:51:46 +0800 Subject: [PATCH] add openEuler-driver-development-specifications.md to version of 22.03_LTS_SP1 Signed-off-by: chenmaodong --- ...Euler-driver-development-specifications.md | 48 +++++++++++++++++++ docs/en/menu/index.md | 1 + 2 files changed, 49 insertions(+) create mode 100644 docs/en/docs/Driver_Development_Specifications/openEuler-driver-development-specifications.md diff --git a/docs/en/docs/Driver_Development_Specifications/openEuler-driver-development-specifications.md b/docs/en/docs/Driver_Development_Specifications/openEuler-driver-development-specifications.md new file mode 100644 index 000000000..faff54a18 --- /dev/null +++ b/docs/en/docs/Driver_Development_Specifications/openEuler-driver-development-specifications.md @@ -0,0 +1,48 @@ +# openEuler Driver Development Specification + +## Target + +In order to standardize and unify the submission process and method of openEuler driver development, and enable the driver on openEuler, the openEuler driver development specification is specially formulated. + +## The Scope of Application + +The openEuler driver development specification applies to the development process of all versions of openEuler under development and released. + +Including but not limited to the following versions: + + +- openEuler 20.03 LTS SP3 +- openEuler 22.03 LTS +- openEuler 22.03 LTS SP1 + +## Basic Requirements for Driver + +Target of openEuler: + +- Become a platform for technology innovation and accelerate technology innovation, maturity, and implementation. +- Maintain security, stability, reliability, leading performance, and stable kernels with a rich ecosystem, facilitating rapid application in the industry + +Therefore, drivers that meet the preceding principles can be submitted to openEuler. + +### Sign the Contributor License Agreement (CLA). + +Before contributing to the openEuler community, a contributor must sign the CLA (https://www.openeuler.org/en/community/contribution/) + +> **Note**: It takes about a week for the CLA to take effect after it is signed. + +### Requirements for drivers + +A driver must meet the following requirements: + +1. The name cannot conflict with an existing name in the system. +2. The driver is tested based on KABIs of the openEuler community. +3. The driver version information is correct. +4. The driver module parameters need to be explained. +5. If there are matching tools, the tools need to be provided. +6. The license information is declared. +7. It is recommended that you add specification for the coupling mode between the driver and the OS release. For example, check the /etc/openEuler-release file or others to determine the technical route. The coupling to specific release information is no longer required. +8. The driver installation guidance must be provided during community warehouse development. + +## Reference Documents +- [Kernel SIG | openEuler Kernel Patch Incorporation Specifications](https://mp.weixin.qq.com/s/rSH79v7btJfsdivC2mki1w) +- [How to Participate in openEuler Kernel Development](https://mp.weixin.qq.com/s/a42a5VfayFeJgWitqbI8Qw) diff --git a/docs/en/menu/index.md b/docs/en/menu/index.md index bf3640300..06822a5af 100644 --- a/docs/en/menu/index.md +++ b/docs/en/menu/index.md @@ -158,6 +158,7 @@ headless: true - [Building an RPM Package]({{< relref "./docs/ApplicationDev/building-an-rpm-package.md" >}}) - [FAQ]({{< relref "./docs/ApplicationDev/FAQ.md" >}}) - [Installing the OBS Tool]({{< relref "./docs/ApplicationDev/installing-obs.md" >}}) +- [openEuler Driver Development Specification]({{< relref "./docs/Driver_Development_Specifications/openEuler-driver-development-specifications.md" >}}) - [secGear Development Guide]({{< relref "./docs/secGear/secGear.md" >}}) - [Introduction to secGear]({{< relref "./docs/secGear/introduction-to-secGear.md" >}}) - [Installing secGear]({{< relref "./docs/secGear/installing-secGear.md" >}}) -- Gitee