Ver código fonte

添加模块功能说明文件

longjin 1 ano atrás
pai
commit
e0a99afe8e
5 arquivos alterados com 36 adições e 0 exclusões
  1. 11 0
      src/console/README.md
  2. 10 0
      src/executor/README.md
  3. 5 0
      src/parser/README.md
  4. 10 0
      src/scheduler/README.md
  5. 0 0
      src/utils/.gitkeep

+ 11 - 0
src/console/README.md

@@ -0,0 +1,11 @@
+# 命令行交互模块
+
+## 介绍
+
+命令行交互模块,使得用户能交互式的进行以下操作:
+
+- 创建dadk task配置文件
+- 查看当前所有的task配置文件
+- 删除task配置文件
+- 查询dadk更新
+

+ 10 - 0
src/executor/README.md

@@ -0,0 +1,10 @@
+# 任务执行器
+
+## 简介
+
+任务执行器是一个独立的进程,用于执行任务,任务执行器的主要功能是:
+
+- 为具体任务设置环境变量
+- 处理构建缓存
+- 执行任务
+- 任务执行完成后,将任务的执行结果发送给任务调度器

+ 5 - 0
src/parser/README.md

@@ -0,0 +1,5 @@
+# 配置解析器
+
+## 介绍
+
+配置解析器是一个用于解析配置文件的工具,它可以将DADK任务配置文件解析成DADKTask对象,并进行一些简单的参数验证。

+ 10 - 0
src/scheduler/README.md

@@ -0,0 +1,10 @@
+# 任务调度器
+
+## 简介
+
+任务调度器用于对要执行的任务进行调度,任务调度器的主要功能包括:
+
+- 检查任务间的依赖关系,确保依赖关系满足后才能执行任务。
+- 对任务进行拓扑排序,确保构建任务能够按照正确的顺序执行。
+- 当具有相同依赖关系的任务同时被提交时,只执行一次任务。
+- 当任务存在环形依赖关系时,为用户提供友好的错误提示:找到环形依赖关系并打印出来,以便用户进行修复。

+ 0 - 0
src/utils/.gitkeep