common/idpf: add README for base code

Message ID 20221101061754.113940-1-beilei.xing@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Qi Zhang
Headers
Series common/idpf: add README for base code |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Xing, Beilei Nov. 1, 2022, 6:17 a.m. UTC
  From: Beilei Xing <beilei.xing@intel.com>

This patch adds README for idpf base code.

Signed-off-by: Beilei Xing <beilei.xing@intel.com>
---
 drivers/common/idpf/base/README | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 drivers/common/idpf/base/README
  

Comments

Qi Zhang Nov. 2, 2022, 12:53 p.m. UTC | #1
> -----Original Message-----
> From: beilei.xing@intel.com <beilei.xing@intel.com>
> Sent: Tuesday, November 1, 2022 2:18 PM
> To: Wu, Jingjing <jingjing.wu@intel.com>
> Cc: dev@dpdk.org; Xing, Beilei <beilei.xing@intel.com>
> Subject: [PATCH] common/idpf: add README for base code
> 
> From: Beilei Xing <beilei.xing@intel.com>
> 
> This patch adds README for idpf base code.
> 
> Signed-off-by: Beilei Xing <beilei.xing@intel.com>

Acked-by: Qi Zhang <qi.z.zhang@intel.com>

Applied to dpdk-next-net-intel.

Thanks
Qi
  

Patch

diff --git a/drivers/common/idpf/base/README b/drivers/common/idpf/base/README
new file mode 100644
index 0000000000..257ad6c4b1
--- /dev/null
+++ b/drivers/common/idpf/base/README
@@ -0,0 +1,21 @@ 
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2021-2022 Intel Corporation
+ */
+
+Intel® IDPF driver
+==================
+
+This directory contains source code of BSD-3-Clause idpf driver of version
+2022.09.13 released by the team which develops basic drivers for Intel IPU.
+The directory of base/ contains the original source package.
+This driver is valid for the product(s) listed below
+
+* Intel® IPU E2100
+
+Updating the driver
+===================
+
+NOTE: The source code in this directory should not be modified apart from
+the following file(s):
+
+    idpf_osdep.h
\ No newline at end of file