svn代码文档提交规范
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
svn代码文档提交规范
1-1.[版本分支]:建立版本分支时须填写的日志规范。
[示例]:
[定制单号] ……
[软件版本] 1.1.0 [语言环境] 中性中文[设备语言] 简体中文
[软件]
1.需求说明:
1)、
2)、
…
2.相关责任人:
——陈翼飞(应用层)、吕军(DSP)、万朋(IE)、金祥庆(SDK)3.关联定制单号及责任人(可选)
[硬件]
1.面板按键修改,责任人:涂文桃
例如:
[定制单号] DZ20100420_04 杭州埃高修改LOGO及IE控件界面升级定制2
[软件版本] V2.1 [语言环境] 英文/中文各一个版本[设备语言] 英文/中文各一个版本[软件]
1.需求说明:
1)需要将当时的定制单编号:DZ20090107_03对应的版本进行升级,支持大硬盘。2.相关责任人:
——周琦(应用层)、中性(DSP)、方钧炜:移植自DZ20090107_03(IE)、中性(SDK)3.关联定制单号及责任人
原定制单号:DZ20090107_03 责任人:周琦
原定制功能:
V2.1,基于中性版本实现功能:
1). 开机界面有两个版本,一个是AB,一个是WISH,语言:英文/中文各一个版本
2). 内部图标更换为定制图标
3). IE控件界面需要定制
[硬件]
1.面板按键修改:中性责任人:无
1-2.[代码提交]:每次提交代码时需填写相关日志。
[说明]:如果是增加新的功能,一次提交必须是属于某个功能的代码,提交后的代码尽量可以通过编译;如果是修正了历史遗留问题等重要更新,需在[BUG]或[CHG]标签之前增加【重要更新】
[示例]:
[BUG] 修正了……问题。
出现概率:……
BUG来源:测试部,客户或者自测等
BUG重现步骤:……
(这里填写notes中的bug_ID,如果没有可不填写,需要注明重现BUG的操作
步骤)
[NEW] 增加了……功能。
原因:……
(注明增加新功能原由,比如客户需求变更。有宏定义的话注明宏定义)
[DEL] 删除了……代码。
原因:……
(注明删除原因)
[CHG] 改进了……功能。
改进原因:……
(需要注明原有功能存在问题)
[TRP] 移植了……代码。
原代码路径:
原代码提供人:……
(需要注明移植代码出处和功能,原代码责任人)
[UDO] 恢复到(还原到、回退到) (1234)
[MER] 合并目录svn://192.0.0.140/DVR-DS9000/branches/v1.1.0中r8347-r8349
的代码。(如果合并的代码比较少,建议把合并过来代码的日志也复制到下面,
如下所示:)
【重要更新】[BUG]更新了(解决了)……问题。(重要更新时使用中文的中括号,
以达到醒目的效果)
1-3.[代码提交]:提交相对独立的模块时需填写相关日志。
[说明]:如果更新了DSP、ramdisk、uImage、logo.yuv、nosignal.yuv、player.bin、ptzCfg.bin、等相对独立的模块,需要注明更新原因、更新内容、相关责任人。对于yuv文件,需要同时上传原图片文件,原图片文件(如果有)存放在docs目录下,和其他文档一起存放,对于ptzCfg.bin文件,需要同时上传源码
【REP】更新了……文件
修改内容:……
文件提供人:……
(注明更新内容、修改原因、相关责任人)
1-4.[代码提交]:每次提交文档时需填写相关日志。
[说明]:增加、修改和删除文档时,需要说明原因。多语言定制需要提交翻译文档。
所有文档都统一放在分支的docs目录下。对于一些不是由提交者写的文档,
需要注明文档创建人。
[示例]:
[ADD] 提交了……文档。
文档创建人:……(可选)