前言
领导让我将以前一个工程的文档给维护的同事。
我只是那个项目的参与者,不是作者。要文档我哪有啊…, 只好尝试将svn提交日志导出给他。
领导以前从来没要求研发向svn提交时写提交日志,也没有要求写changlog和其他设计文档,这时候问我有没有文档,整的有点懵逼。
还好我提交日志的习惯还蛮好的,每次提交都会写提交的原因文本。
上网找了一下,已经有同学做了实验。
我也记录一下。
实验
在svn目录中建立一个实验目录,添加几个文件,修改几次,并分别提交,提交时写一些提交日志。
浏览svn日志
导出日志的选择
导出日志的选择有6种。
如果工程比较大, full data 比较大,看的眼晕。
我选择了“Full revision data without changed paths”, 这个导出现象除了不包括被修改的文件列表,其他信息都在,比较合适导出给没有此svn权限的人观看此工程的进化,类似于changelog。
导出后的svn提交日志样子
Revision: 1429
Author: cx
Date: 2020年12月21日 9:52:37
Message:
// 假装完成了一个功能,仅供日志导出实验用
----
Revision: 1428
Author: cx
Date: 2020年12月21日 9:51:02
Message:
add test prj.
----
Revision: 1427
Author: cx
Date: 2020年12月21日 9:47:25
Message:
增加工程目录说明。
----
Revision: 1426
Author: cx
Date: 2020年12月21日 9:46:14
Message:
增加"测试svn导出日志实验工程"的目录
----
碎碎念
领导一般不是搞技术的,平时不提文档要求,只管需要的时候要东西。
研发又比较懒,很少写文档。
如果要折中一下的话,研发要勤提交svn日志, 工程每进化一步,就提交日志(必须写上有意义的提交原因)。
这样,领导要文档,如果没有专门整理的文档(设计文档),也可以将svn日志导出凑合一下给领导看。也能大致看出工程的进化过程。