DVC Central Wrapper Command 软件规格书


一、目标说明

本软件规格书定义了 DVC Wrapper Command(中央命令)的使用规范与行为标准,用于支持项目管理者(PM)、设计工程师(Engineer)、CAD 管理者等用户在 DVC 中央仓(SVN)中进行设计数据的正式版本控制操作。此命令集通过对 SVN 的封装,确保流程合规、安全、可审计。


二、使用角色与典型应用场景

角色

  • PM:项目版本创建、签核、审批。
  • Engineer:上传设计数据、下载资料、对接上下游。
  • CAD:初始化项目、维护环境、设置目录结构。

应用流程示意

  1. 工程师上传设计数据
  2. PM 审批并确认为正式版本
  3. 数据进入 DVC SVN 仓库
  4. 下游工程师 checkout 正式版本继续开发

三、命令清单与规范

3.1 dvc project checkout

功能:检出指定项目的 SVN 版本数据到本地工作目录 语法

dvc project checkout

说明:需先设置环境变量 source /projects/<proj_code>/cshrc_dop,默认目录 $DVC_WORKING 可设定。


3.2 dvc folder create

功能:在 SVN 中创建 DVC 四层结构路径 语法

dvc folder create <phase>/<block>/<stage>/<version>

示例

dvc folder create P1-trial/cpu/200-LOGIC/20240618_v1

3.3 dvc folder checkout

功能:将远程 SVN 中的版本路径检出至 $DVC_WORKING 语法

dvc folder checkout <phase>/<block>/<stage>/<version>

说明:用于将数据拉取到本地进行复制或查看。


3.4 dvc object copy

功能:复制本地文件/目录到 folder checkout 的工作区中 语法

dvc object copy <src_path> <dst_filename>

说明:与 cp 命令类似,源文件来自工程师本地路径。


3.5 dvc object link

功能:建立符号链接至指定路径下的对象 语法

dvc object link <src_path> <link_name>

说明:用于 Team Leader 整合多源数据时创建链接指向上游资料。


3.6 dvc dvcpath checkin

功能:将本地工作目录中的数据提交回 SVN 仓库 语法

dvc dvcpath checkin <phase>/<block>/<stage>/<version>

说明:数据上传前需先执行 folder checkoutobject copy/link


3.7 dvc dvcpath confirm / confirmlist / confirminfo

功能:版本审批

  • confirmlist:列出待确认的版本路径
  • confirm:正式确认某版本
  • confirminfo:查询提交人信息

四、目录结构命名规范

遵循 DVC 四层结构标准:

<Phase>/<Block>/<Stage>/<Version>
  • Phase:P1-trial、P2-final 等,由 PM 定义
  • Block:cpu、ddr、top 等模块名
  • Stage:000-DATA、200-LOGIC、400-APR 等
  • Version:如 20240618_init,建议包含日期与用途标记

五、环境要求

执行前须加载项目环境变量:

source /projects/<proj_code>/cshrc_dop

并设置 $DVC_WORKING(默认路径为 ~/DVC)


六、异常处理与说明

问题说明与建议处理
权限不足确认是否为项目账号或联系项目负责人授权
版本路径不存在检查输入路径,确认是否已有 folder create
数据未 checkin确保已先执行 folder checkoutobject copy

七、附录

  • 本命令集封装 SVN 与设计流程,对使用者隐藏底层细节,提高可靠性与一致性。