From 9fa4a7726e3ff636cd362ab8e7280aba02927850 Mon Sep 17 00:00:00 2001
From: king_he <6384784@qq.com>
Date: Thu, 5 May 2022 12:20:38 +0000
Subject: [PATCH] update OAT.xml. Signed-off-by: king_he <6384784@qq.com>

---
 OAT.xml | 46 +++++++++++++++++++++++-----------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/OAT.xml b/OAT.xml
index 78d61212..199b097c 100644
--- a/OAT.xml
+++ b/OAT.xml
@@ -14,38 +14,38 @@
      limitations under the License.
 
 -->
-<!-- OAT(OSS Audit Tool) configuration guide:
-basedir: Root dir, the basedir + project path is the real source file location.
+<!-- OSS Audit Tool (OAT) configuration guide:
+basedir: Root dir. basedir + project path is the real source file location.
 licensefile:
-1.If the project don't have "LICENSE" in root dir, please define all the license files in this project in , OAT will check license files according to this rule.
+If the project doesn't have "LICENSE" in root dir, please define all the license files in this project. OAT will check license files according to this rule.
 
-tasklist(only for batch mode):
-1. task: Define oat check thread, each task will start a new thread.
-2. task name: Only an name, no practical effect.
-3. task policy: Default policy for projects under this task, this field is required and the specified policy must defined in policylist.
-4. task filter: Default filefilter for projects under this task, this field is required and the specified filefilter must defined in filefilterlist.
-5. task project: Projects to be checked, the path field define the source root dir of the project.
+tasklist (for the batch mode only):
+1. task: OAT check thread. Each task will start a new thread.
+2. task name: Task name.
+3. task policy: Default policy for projects under this task. This field is required and the specified policy must be defined in policylist.
+4. task filter: Default filefilter for projects under this task. This field is required and the specified filefilter must be defined in filefilterlist.
+5. task project: Projects to be checked. The path field defines the source root dir of the project.
 
 
 policyList:
-1. policy: All policyitems will be merged to default OAT.xml rules, the name of policy doesn't affect OAT check process.
-2. policyitem: The fields type, name, path, desc is required, and the fields rule, group, filefilter is optional,the default value is:
+1. policy: All policyitems will be merged to default OAT.xml rules. The name of policy doesn't affect the OAT check process.
+2. policyitem: The fields type, name, path, desc are required, and the fields rule, group, filefilter are optional. The default value is:
 <policyitem type="" name="" path="" desc="" rule="may" group="defaultGroup" filefilter="defaultPolicyFilter"/>
 3. policyitem type:
-    "compatibility" is used to check license compatibility in the specified path;
-    "license" is used to check source license header in the specified path;
-    "copyright" is used to check source copyright header in the specified path;
-    "import" is used to check source dependency in the specified path, such as import ... ,include ...
-    "filetype" is used to check file type in the specified path, supported file types: archive, binary
-    "filename" is used to check whether the specified file exists in the specified path(support projectroot in default OAT.xml), supported file names: LICENSE, README, README.OpenSource
+    "compatibility" is used to check license compatibility in the specified path.
+    "license" is used to check source license header in the specified path.
+    "copyright" is used to check source copyright header in the specified path.
+    "import" is used to check source dependency in the specified path, such as import and include.
+    "filetype" is used to check file type in the specified path. Supported file types include archive and binary.
+    "filename" is used to check whether the specified file exists in the specified path (support projectroot in the default OAT.xml). Supported file names include LICENSE, README, README.OpenSource.
 
-4. policyitem name: This field is used for define the license, copyright, "*" means match all, the "!" prefix means could not match this value. For example, "!GPL" means can not use GPL license.
-5. policyitem path: This field is used for define the source file scope to apply this policyitem, the "!" prefix means exclude the files. For example, "!.*/lib/.*" means files in lib dir will be exclude while process this policyitem.
-6. policyitem rule and group: These two fields are used together to merge policy results. "may" policyitems in the same group means any one in this group passed, the result will be passed.
-7. policyitem filefilter: Used to bind filefilter which define filter rules.
-8. filefilter: Filter rules, the type filename is used to filter file name, the type filepath is used to filter file path.
+4. policyitem name: This field is used to define the license, copyright, "*" means match all, the "!" prefix means could not match this value. For example, "!GPL" means can not use GPL license.
+5. policyitem path: This field is used to define the source file scope to apply this policyitem, the "!" prefix means exclude the files. For example, "!.*/lib/.*" means files in lib dir will be exclude while process this policyitem.
+6. policyitem rule and group: These two fields are used together to merge policy results. "may" means that the result will be passed if any policyitem in the same group is passed.
+7. policyitem filefilter: This field is used to bind filefilter which define filter rules.
+8. filefilter: This field is used to define filter rules. filename is used to filter file name, and filepath is used to filter file path.
 
-Note:If the text contains special characters, please escape them according to the following rules:
+Note: If the text contains special characters, please escape them according to the following rules:
 " == &gt;
 & == &gt;
 ' == &gt;
-- 
Gitee