SVN使用规范-详解.doc

目 录第一章引言11.1Subversion的介绍11.2Subversion的特性11.3SVN链接模式21.4SVN操作流程3第二章SVN使用42.1SVN软件安装42.2事业部SVN库介绍42.2.1事业部SVN库42.2.2帐号注册、权限申请52.3基本操作52.3.1操作介绍52.4系统规范使用182.4.1规范操作182.4.2版本控制的使用192.4.3与目录无关内容192.4.4文件夹目录名称规范202.4.5文件上传格式212.4.6文件、数据放置212.5日常使用问题212.5.1版本库无响应212.5.2邮件中的路径链接212.5.3系统库最上层打不开222.5.4提交失败（Commit fail）222.5.5SVN文件夹无法下载232.5.6特征图标的显示232.5.7冲突问题解决24第三章权限申请流程263.1权限定义263.2申请流程263.2.1普通权限申请263.2.2单位权限申请263.2.3特殊权限申请273.3表单使用28附录1参考文献5SVN使用规范第一章 引言1.1 Subversion的介绍SVN是Subversion的缩写。Subversion管理随时改动的文件和目录，以二进制格式存储所有的文件，使用高效的比较二进制差异算法来计算版本之间的改动。同时，它是一个时间机器，随时记录文件和目录的每次改动，例如：文件的增加、删除、重新排列文件等。同时SVN允许你恢复以前旧版本的数据，或者检查数据变化的历史。SVN使用类似数据库事物的方式来处理用户提交入库的过程，整个改动要么成功的被提交，要么被中断并回滚。在数据提交完之前，其他人是看不到用户提交的修改文件，你看到的要么是改动之前的状态，要么是改动之后的状态。这样的行为被称为“原子提交”。原子提交很有用，因为它能保证所有相关人员看到的总是相同的东西。原子提交过程的其中一步就是包括把你的所有改动打包为一个“修订集”（有时被称为改动集），并且再给个改动标记的修订号（绿色勾变为红色叹号）。1.2 Subversion的特性1.2.1 版本化的目录 Subversion实现了一个可以跟踪目录树更改的“虚拟”版本化文件系统，文件和目录都是有版本的。1.2.2 真实的版本历史 通过Subversion你可以对文件或是目录进行增加、拷贝和改名操作，也可以新增一个具有干净历史的文件。可以毫不夸张的将每一个版本都可以作为一个记忆片段定点。1.2.3 原子提交版本库采用二进制差异形式提交修改的数据内容，一系列的改动，要么全部提交到版本库，要么一个也不提交，这样可以让用户构建一个需要提交修改的逻辑块，放置部分修改提交到版本库。1.2.4 一致的数据操作Subversion表示文件是建立在二进制文件区别算法基础上的，对于文本（可读）和二进制（不可读）文件具备一致的草所方式，两种类型的文件都压缩存放在版本库中。1.3 SVN链接模式其中本地工作副本与SVN系统链接的媒介是“.svn”隐藏文件夹，.svn隐藏文件夹中包含了系统链接、版本等信息，图1-1为本地工作副本与SVN系统链接后状态，绿色勾代表文件受系统控制（后面简称：受控）标志，红色叹号为受控文件改动标志。图1-1 链接状态1.4 SVN操作流程WorkingCopyWorkingCopyRepositoryNetwork版本库网络本地工作副本检出、提交图1-2 操作流程图图1-2总体概括了SVN整个操作过程：首先用户从版本库通过网络“检出”到本地工作副本中，然后，在本地工作副本中进行增加、修改、删除文件后“提交”到版本库中，如果本地工作副本中版本较系统版本过时，用户使用“更新”功能与系统上版本保持一致。第二章 SVN使用2.1 SVN软件安装SVN的安装软件是公司受控软件，用户安装需要由各单位文员走软件安装的OA流程，在接到流程申请后电脑中心安排阳光服务安装。如果SVN软件在电脑重装系统后被卸载掉，请用户直接联系电脑中心（内线：63333）处理。2.2 SVN库介绍2.2.1 SVN库SVN库，分别是：办公库（office）、车型项目库（public）、公共资源库（public）、数据传输库（FTP 15b）。其中办公库、车型项目库、公共资源库为同一帐号密码；数据传输库为独立帐号，便于数据库后台的清理。各库的登录路径如下：n 办公库（office）：各单位职能部门工作平台。登录路径：/officen 车型项目库（project）：事业部承接的所有车型项目工作平台。登录路径：/projectn 公共资源库（public）：事业部专利、共享资源、文件、表单等数据文档放置点。登录路径：/publicn 大数据传输：应用于事业部内部数据传输的数据传输库（FTP 15b），确保各单位之间递的便捷。登录路径：svn://FTP 15b2.2.2 帐号注册、权限申请1. 用户帐号注册：新进员工没有SVN帐号，通过邮件联系SVN管理员（管理员联系方式请见附录三），邮件正文注明申请SVN普通帐号，管理员处理完帐号注册事宜后，会邮件回复。 注：普通帐号，只对公共区域目录有读取权限。2. 权限的申请：用户一律通过各单位SVN干事（SVN干事联系方式请件附表一、附表二）申请SVN权限，由SVN干事统一汇总权限申请单。凡是涉及到事业部层面的权限申请或者是涉及到非本部门的权限申请，一律填写特殊权限申请单，在各方领导审核审批后，交由SVN管理员处理，在管理员处理完毕后回复用户。 权限的具体申请流程在后面的第三章中将详细介绍。2.3 基本操作2.3.1 操作介绍1. 系统登录点击鼠标右键出现功能选项，选择“TortoiseSVN”中的“版本库浏览器”，这时系统弹出URL界面，用户在URL中输入需要进入的库路径，弹出登录认证框，用户输入用户名和密码进入系统主界面。 图2-1(a) 系统登录图2-1(b) 认证界面图2-1(c) public库系统界面图2-1（a）和图2-1（b）是系统登录操作界面，图2-1（c）是系统的主界面，三副图中整体描述了SVN系统的登录情况。注：图2-1（b）中“Save authentication”是保存认证选项，用户根据需要对自己的用户名和密码进行保存，以便在下次操作时不需要再次输入用户名和密码了。2. 设置功能的使用在上节类容中主要讲述了系统的登录方式和认证保存的方法，接下来继续讲述系统“设置（Setting）”功能的使用。在设置中，用户可以根据需要选择系统的语言显示、清除已保存的数据、显示特征标志等等。（1） 系统语言显示选择图2-2 系统语言中-英文转换系统安装后全部默认为英文模式，这时需要用户手动切换到中文模式。图2-2中描述了中英文切换的过程，在选择“设置（Setting）”功能后弹出的对话框自动显示语言栏（Language），用户选择“中文（简体）”后确认即可。（2） 忽略上传文件SVN系统有一个似过滤器的功能，在本地工作副本中用户可以根据需要过滤一些不需要上传到服务器的文件，这个功能就是“全局忽略样式”。图2-3（a） 全局忽略样式忽略样式对提交文件扩展名进行选择性忽略，忽略格式通常以*.X形式被系统识别，例如：用户不需要将编译产生的.o和.err文件提交到SVN上，这时用户在全局忽略样式中输入*.o *.err如图2-3（a），各条目之间以空格分隔。注意：当用户在本地工作副本中对新添加文件采用了系统添加功能操作，忽略样式功能对本地副本中的文件将不起作用，如图2-3(b)表蓝色加号表示文件已添加；另外还有一种情况，如果已经将想忽略的文件提交到了SVN系统上，是无法进行忽略的。图2-3（b） 添加文件样式（3） 保存清除在对系统保存认证后相应需要对认证进行清除，清除功能仍然在设置模块中，界面如图2-4。在保存清除中共可以对本地四种已保存数据进行清除，分别有URL历史记录、日志信息、窗口大小、认证数据，在对这些数据完全清理后系统自动恢复到“零”状态。因此，用户在离机后也别忘记将保存认证数据清除掉，以保障资料的安全性。图2-4(a) 认证清除图2-4(b) 密码清除（4） 特征标志选择不少用户在使用SVN“检出”功能后，本地工作副本没有出现特征符号绿色勾或其他特征符号，这是由于系统无法识别默认的状态缓存，需要人工手推选择状态缓存方式，改变状态缓存方法如图2-5，在设置中选择“外观与样式”的“图标叠加”模块，再在“状态缓存”中选择“Windows外壳”。图2-5 特征显示设置中其他不常用的功能不再进行一一介绍，用户可以根据日常操作实践来理解。3. 在SVN系统上进行日常工作SVN系统不支持直接在系统上对文件修改的操作。如果有受控文件需要修改，用户可以通过在本地工作副本中修改后提交到系统上，这中间的媒介就是.svn隐藏文件夹，系统的整个操作范围：“检出”“提交”“更新”，接下来给大家详细介绍各操作。（1）本机文件夹与服务器文件夹之间的链接首先，在本地电脑新建一个文件夹，并给文件夹重新命名；然后，鼠标选择文件夹，点击右键选择“检出（Checkout）”功能,使用检出功能后本地文件夹有一个绿色的勾，称之为本地“工作副本”。图2-6（a）中黄色框为SVN路径选择区域，绿色框为本地路径选择区域，用户根据需要在后面按钮处选择相关下载路径。图2-6（b）中为系统文件夹检出到本地后的状态。 图2-6（a） SVN检出按钮图2-6（b） SVN检出视图另外，用户还可以在系统界面直接检出需要文件夹到本地，在服务器界面选择需要下载文件夹如图2-6（c），然后点击右键选择“检出”功能再继续按照以上操作即可。注：用户需要注意“检出”功能只针对系统文件夹，对于系统中单个文件是不能够使用检出的。图2-6（c） 界面SVN检出（2）日常操作上传SVN当创建了本地工作副本后，可以在副本中进行任何日常操作，如：增加文件夹、文件、修改文件、数据等，用户每天下班前将需要本地副本中做的修改提交（Commit）到SVN上，确保服务器上数据与本地副本中的数据保持同一版本。需要强调的是，虽然用户在本地创建了工作副本，但如果所有执行操作没有提交到SVN上，一旦本机数据丢失，将无法追溯。用户在提交时需要注意两点，如图2-7： 选择提交无版本控制选项，避免出现新增文件漏提现象； 日志备注的填写，方便后续对文件的追溯。图2-7 SVN提交（3）文件修改差异比较SVN系统有一个非常适用的功能“修改差异的比较”，可以将本次修改内容和原稿作比较并显示出来，图2-8（a）为提交版本与修改前差异比较方法，图2-8（b）为追溯历史版本之间差异的比较方法。图2-8（a） 修改差异比较图2-8（b） 追溯差异比较1图2-8（b） 追溯差异比较2（4）历史追溯SVN系统的记忆犹如时间片段的集合，每一个版本代表了一个时间定点，当用户需要回顾或追溯之前的某一个时间节点时，通过系统的日志显示（show log）功能来实现。通俗一点讲，十五部的SVN系统正是一部录制过程中的电影，每一个用户提交的内容都是劳动集成点的片段，当某一天用户需要回忆某个记忆点时，可以结合图2-9的操作来实现。在看图2-9之前， 先回到2-8（b）的过程中，选择了显示日志功能列表中有一个专用“浏览版本库”功能，用户通过这个功能可以回到之前任意一个版本时代。图2-9 历史记录追溯（5）系统自带的搜索功能SVN系统自带强大的搜索功能，用户可以通过选择日志信息、路径、作者、版本号查询所需版本文件。具体操作步骤如下：第一步：选择需要查找的目录，右键选择“显示日志”功能，弹出图2-10（a）界面。第二步：如果日志信息在100条以上，需要选择左下角的“全部显示”或“下100”按钮。图2-10（a）日志显示 第三步：从对话框右上角的放大镜窗口选择需要搜索的信息，例如：需要查询zhaoxizu提交的文件，在对话框中输入zhaoxizu回车即可，如图2-10（b）。图2-10(b) 系统自带搜索（6）SVN辅助功能使用SVN辅助系统主要应用于public、project、office三个库中，功能主要包括用户密码的修改、使用记录查询、文件搜索三个模块。 客户端界面登录用户通过IE浏览器输入路径 :8080 进入图2-11界面，然后输入SVN用户名和密码登录管理系统。图2-11 辅助功能登录界面 其他辅助功能的使用进入管理系统界面后，用户根据需要来修改密码和搜索文件等等。图2-12 密码修改2.4 系统规范使用SVN系统的日常使用一律按照SVN使用管理办法执行。2.4.1 规范操作日常文件更新一律按照“检出提交”的方法，用户需要在本地创建工作副本，在本地修改后提交到SVN系统上，不允许直接将文件拉到系统上，图2-13中列举用户操作不规范现象。 2-13 使用不规范现象2.4.2 版本控制的使用文件的追溯性主要表现在文件的版本提交控制情况，一个文件或数据的成型可能经历上百个版本修改。因此，只要使用好版本控制，不仅节省脑力劳动，而且提高了工作效率，当日文件修改后提交过程中日志备注是必不可少的。图2-14 版本控制管理2.4.3 与目录无关内容SVN系统平台是事业部各人员日常工作平台，提交的文件和数据均是工作相关内容，因此不允许用户将私人照片、电影等不相关内容上传。另外在project库中研发工程师需按照PQE项目质量拟定的基线目录提交相关内容，图2-15中列举了M6车型中上传F3项目的不规范现在。图2-15 使用不规范目录2.4.4 文件夹目录名称规范用户在提交日常文件成功后，系统会自动精确到秒的记录用户所有操作，因此，用户在日志备注中注明提交原因和较详细的描述修改的地方，不需要在文件夹名后添加文件修改日期，图2-16中形象的表现了用户在文件夹后加日期不规范现象。图2-16 文件夹带日期不规范现象2.4.5 文件上传格式日常更新的文件、数据不能转换成PDF、压缩包等格式提交；文件不用压缩，不能设置密码。2.4.6 文件、数据放置 文件、数据不允许重复放置。2.5 日常使用问题2.5.1 版本库无响应在版本库浏览器中输入SVN路径后系统处于无响应状态。解决方法：检查SVN路径是否输入正确，如果正确，请用户确认路径和符号是否在英文模式下输入的，如果不是请将其修改为英文模式。导致原因：由于SVN现阶段只支持全英文状态路径，因此用户在输入路径时要注意。2.5.2 邮件中的路径链接直接点击邮件中的链接地址为何打不开文件？导致原因：输入路径太长，OE（Outlook Express）中只默认到一定字节数，导致点击链接文件无法达到底层目录或直接发生链接错误。解决方法：在OE中选择“插入”“超级链接”“URL”，将全部路径粘贴进URL中，接收方在点击链接后能顺利打开文件。如图2-17：图2-17 outlook路径输入模式2.5.3 系统库最上层打不开导致原因： 网络不通； 使用IE代理； 路径输入错误.问题解析：用户要清楚一点，所有系统帐号，最上层是一定能打开的，除非你没有SVN帐号。一旦发现上述情况，用户首先是检查路径的正确性。如果路径正确，请确认是否存是由以下两种因素引起的。（1）首先，请检查网络是否连通；（2）其次，检查是否使用了网络代理，由于Apache关系，用户在使用代理后是无法登录SVN的。2.5.4 提交失败（Commit fail）（1） 文件提交不上图2-18 文件无法提交导致原因：绿框内记录了问题点存在的直接原因，当用户提交文件时，系统提示路径不存在，该路径指代的是系统上与本地链接的路径已经不存在。此时，用户首先确认是否对服务器上相应目录名称做过改动，或者是将该目录移植、删除。（2）没有权限看到报错信息中包含以上信息（Commit fail）时，请联系SVN管理员处理权限配置。2.5.5 SVN文件夹无法下载如果一个文件夹内容的无法下载，导致原因有两种：（1）文件名末尾有空格解决方法：将文件名称的空格去除，再执行下载操作。（2）本地目录中已下载相同路径（如以下图片）在本机中已存在“.svn”路径的目录下继续下载第二个目录是不可执行的操作，如图2-19。解决方法：如果真需要继续在本目录中下载其他文件夹，用户在该目录下新建一个文件夹后再执行检出操作，以新建目录为本地副本。图2-19 目录无法下载2.5.6 特征图标的显示明明是检出了，受控文件（夹）为何没有绿色勾？导致原因：由于个别电脑无法识别SVN默认选择的Default，因此电脑在检出后没有绿色勾特征。解决方法：在设置中的Icon Overlays 中选择Status cache 的（外壳）Shell项即可，如果仍然没有显示，用户重启电脑。图2-20 标志显示类型选择2.5.7 冲突问题解决导致原因：由于用户操作不当，或由于版本过期引起。冲突现象分为轻微型冲突和死亡型冲突，由于版本过期使用更新操作时引起的可通过SVN功能解决的冲突定义为轻微型冲突，由于操作不当无法用SVN功能解决的冲突较死亡型冲突。图2-21冲突产生轻微型冲突解决方法：在发生轻微型冲突现象后，用户使用功能已解决的（Resolved）来处理该事件。图2-22冲突解决死亡型冲突解决方法：在发生死亡型冲突后，已解决的功能无法解决错误问题，用户只能舍弃现有本地工作副本，重新从服务器上下载版本库，然后通过覆盖新下载数据方式继续进行下一步操作。注：在覆盖前一定要将舍弃的本地工作副本中.svn隐藏文件夹删除掉。2.5.8 提交时出现的磁盘空间不足问题部分用户在提交时数据到SVN上时，系统提示磁盘空间不足信息。导致原因：由于存放工作副本的磁盘剩余空间较小，达不到提交所需的资源释放。问题解决：用户检查磁盘空间量，并释放冗余空间。2.5.9 IE浏览器与版本库浏览器的差异相同点：两者都能下载。两者差异：使用版本库浏览器登录可以“检出”“提交”，并且包含所有的SVN系统功能；使用 IE浏览器登录可以查阅及下载，不包括SVN系统涵盖的系统功能。能使用IE浏览器登录的库有project、public、office三个版本库，由于FTP 15b（数据传输库）为单独设立的版本库，使用SVN自带服务运行故与其它三个库不相关联不能。第三章 权限申请流程3.1 权限定义用户对SVN使用包括写入和读取权限，在现有库中车型项目库和办公库权限需要由SVN干事（两地区干事联系方式见附录表一和表二）统一申请，公共库大部分信息对有帐号人员默认读取。写入(w)：一律由各单位SVN干事申请；读取(r)：单位读取权限由SVN干事申请。公共资源读取权限为默认，如无帐号人员向管理员申请帐号后默认开通。3.2 申请流程3.2.1 普通权限申请由用户发送权限申请邮件给SVN管理员，管理员确认用户信息后注册帐号，管理员将注册后帐号、密码通过邮件形式发送给用户。3.2.2 单位权限申请（1）由SVN干事拟定权限申请表单分厂/部门经理确认签字SVN管理员权限配置；（2）SVN干事拟定权限申请表单邮件发送SVN管理员（抄送分厂/部门经理）分厂/部门经理确认回复SVN管理员权限配置SVN干事补签字权限表。（注：仅限领导出差）。拟定权限表单邮件发送领导确认签字权限设置补签字权限表单领导确认回复权限设置一图3-1 SVN权限申请流程3.2.3 特殊权限申请各单位间的SVN权限申请统一填写SVN特殊权限申请单，具体操作流程如下：图3-2 特殊权限申请流程申请方填写填写特殊权限申请表部门/分厂经理签字权限设置文件夹所属部门经理审核SVN管理员权限设置如果涉及到事业部层面的SVN权限，需要由事业部总经理或事业部总工程师签字，方可生效。如：事业部车型项目管理权限。3.3 权限申请表单1）表单SVN路径为：/public/02 公共资源/2.9_SVN相关资料/9.3svn使用表单2）表单填写标准见下表6SVN车型权限申请表 表码：QR-LA-006(A/1) 编号：序号分厂/部门科室车型项目/SVN根目录项目负责人项目管理员PQESVN子目录读 R：姓名，写 W：姓名备注30仪表厂开发部S6左前窗控/DMCU夏立闯杨磊廖宜辉刘万祥BOMW：夏立闯 石春山 游桂忠 孙成新 王晓伟 杨磊 陈玲玲2 宋颖超 陈清水 陈双军 黎玉明 张星娟R:廖宜辉 王佩 韩礼2 余欣2 龚志友 DOCUMENTW:夏立闯 石春山 游桂忠 孙成新 王晓伟 杨磊 陈玲玲2 宋颖超 廖宜辉 陈清水 陈双军 黎玉明 张星娟 王佩 韩礼2 余欣2龚志友HARDWAREW：夏立闯 石春山 孙成新 杨磊 陈玲玲 宋颖超 陈清水 陈双军 黎玉明 张星娟 游桂忠R: 廖宜辉 王佩 韩礼2 余欣 2龚志友编制：批准： 流动路线：申请部门 确认部门 项目管理部 保存单位：项目管理部 保存期限：3年 备注：编制和批准时一定要将年月日注明 SVN职能部门权限设置申请表 表码:QR-LXM-0005(A/0) 编码：序号分厂/部门科室科室负责人SVN根目录子目录读 R：姓名，写 W：姓名 备注1项目管理科/谢平生IntegratedManagement团队建设W：谢平生R：杨静、涂国丽、张艳、杨喜红工作手册W：杨静、涂国丽、张艳、杨喜红R：王斌燕标准化工作W：杨静、涂国丽、张艳、杨喜红编制：批准： 流动路线：申请部门 确认部门 项目管理部 保存单位：项目管理部 保存期限：3年 备注：编制和批准时一定要将年月日注明第十五事业部 SVN特殊权限申请表表码：QR-LXM-0004（A/0） 编号：申请人王敏工 号576708部 门项目管理部职 务项目管理工程师SVN申请路径/project/F6申请权限 读取权限 （R） 备注： 写入权限 （RW） 备注：申请理由学习车型项目管理访问有效期 无限期有限期： 2008年12月22日 2008年01月22日申请部门审核意见： 不同意 需再次确认 同意 主管/经理： 谢平生 日期：2008.12.22确认部门审核意见： 不同意 需再次确认 同意主管/经理： 日期： * 事业部审核意见： 不同意 需再次确认 同意 事业部总经理/总工程师：邹财松/罗如忠 日期：2008.12.22项目管理部处理结论： SVN管理：李玉 日期：2008.12.22流动路线：申请部门 确认部门 事业部总经理、总工程师 项目管理部保存单位：项目管理部 保存期限：3年备注：1. SVN申请路径必须明确2. * ：按文件夹秘密等级度选择附录附表一：深圳地区SVN干事联系方式分厂/部门名称深圳联系方式手机邮箱多媒体厂孙少君64967/S气囊厂石为利6276213510888468空调厂任 晖6756713632992908仪表厂黄春丽6309513632991318结构零件厂郭金娜66260/线束厂藏晓亮6568613632993816开关厂王 伟6300813632990495汽车电子研究所何晓飞67927/测试技术部周三林6306113632992503总经办李 玉67951/资源开发部牛杰英62852/成本部李 玉67951/人力资源部李霖霖6304613632993878项目管理部李 玉67951/工程部何 芳6276113510886271PQE品质部李 玉67951/仓储物控部罗红霞62842/附表二：西安地区SVN干事联系方式分厂/部门名称西安联系方式手机邮箱多媒体厂刘媛妮25236/气囊厂贾 琛2528413720609347空调厂吴 蕾2526113720607721仪表厂陈 香25054/结构零件厂陈星宇2504613759951559线束厂李宇鹏2504413720608739开关厂孟晓凤2271413720607323汽车电子研究所/测试技术部/总经办陈 新2504515829291093资源开发部杨 霏2518113720609626成本部李贺康25092/人力资源部陈 新2504515829291093项目管理程部张 宁2509313720603702PQE品质部刘亚茹李晓丹25104251021372060958713720609303仓储物控部张新平2527313720601401附录三：SVN管理员联系方式胡能 项目管理部 内线：67951 电话玉 项目管理部 内线：679