代码之家  ›  专栏  ›  技术社区  ›  mandel

哪些文档应该添加到svn仓库中?

svn
  •  4
  • mandel  · 技术社区  · 16 年前

    我正在做一个个人项目,虽然我有一个维基,但我想向svn存储库添加不同的文档文件。这些文件包括XML(由monodoc生成)以及UML图(由dia生成)。

    这是一个好主意,我听过/读过关于不向svn仓库添加二进制数据的评论,并试图只保留代码,对吗???

    10 回复  |  直到 16 年前
        1
  •  16
  •   Tim Cooper    13 年前

    这不是关于二进制与文本,而是关于它是否生成。如果你生成了这些东西,为什么不将生成源和生成工具一起添加到SVN中,而不是生成的文件本身呢?然后,再加上良好的构建脚本(也在SVN中),您始终可以重新生成它们。否则,您将面临生成的文件与源文件不同步的风险,或者人们将生成的文件视为“主文件”并混淆地覆盖其更改的风险。

        2
  •  3
  •   Garry Shutler    16 年前

    我会将所有文档、库和其他任何东西添加到存储库中。基本上是与项目相关的任何内容,因为这样每个人都可以访问它,并且也将拥有最新版本。

        3
  •  1
  •   Avi    16 年前

    我认为在SVN中保留任何无法从源文件重新生成的文件是完全可以的。这包括dia/xml文档和图像。

    当然,在可能的情况下,最好将它们存储为文本——因此,CSV电子表格比Excel文件更好。

        4
  •  1
  •   itsmatt    16 年前

    除了最终产品的版本之外,我不倾向于将大量二进制文件放入subversion中。通常,如果我能在运行中生成一些东西,我就不会费心,除非生成它们需要太长时间,然后我就把它们粘在那里。

    也就是说,如果svn能让我的生活更轻松,我宁愿把最新文档的副本(不管我是否能轻松地对其进行区分)扔进svn。当老板或客户说“你有10月份的xyz文件吗?”时,能够拿到某件事的副本(无论是最新版本还是以前的版本)总是很好的。

    至于你的特殊需求,好吧。只有你知道,但磁盘空间很便宜,如果有价值的话,我会这样做。

    只有我的两分钱。

        6
  •  0
  •   Joonas Pulakka    16 年前

    添加与项目有关的所有内容。添加二进制文件(例如库)没有问题, :避免添加重复数据,例如从源代码编译的文件。

        7
  •  0
  •   Ned Batchelder    16 年前

    svn可以很好地处理二进制文件,但我不会添加构建文件,只会添加源代码。如果你的文档是从其他文件生成的,不要签入,让其他开发人员自己构建。只有当文件难以构建时,我才会将其签入Subversion。

        8
  •  0
  •   Krzysztof Kozmic    16 年前

        9
  •  0
  •   Laserallan    16 年前

    如果你有一个可以巧妙地合并和区分的文档系统,我认为文档的“源”应该在树中。I.是.tex文件,不是.pdf。

    如果你分支了一个需要编辑代码和文档的版本,那么文档的更改也将在SVN中。当您发布时,您可以从代码和文档源中的文档构建二进制文件。

    如果你从分支中反向移植内容,你也可以反向移植其相应的文档。

        10
  •  0
  •   Peter Neubauer    16 年前

    我将创建并可能更改的数据放入SVN中。例如,我将源代码、解决方案和make文件以及文档放在SVN中。我尽量避免添加生成的文件,例如从其他格式、二进制文件和第三方库生成的PDF。我不生成和更改的内容,如其他供应商的手册,最终会出现在共享文件夹中。这与其他人的说法非常一致。