使用git管理项目的Doxygen？

Question

我正在研究C++和Objective C iPhone项目.我正在使用git作为我的版本控制系统.

代码库已经增长了很多,所以我想将doxygen添加到项目中.问题是我不确定这样做的最佳方法是什么.

我考虑过几个选项:

1)在项目文件夹中创建doxygen HTML文档,并使其成为项目的"部分",以便它也被版本化并提交给git.

2)在项目文件夹中创建doxygen HTML文档并将其添加到项目中,.gitignore因此项目的每个用户都负责生成文档,项目git存储库将保持不变(除了.gitignore).

我们在主服务器中使用git --bare存储库,因此在服务器中安装包含HTML doxygen的网页会很复杂(你实际上看不到带有git的项目文件--bare repo,所以我赢了除非我单独上传,否则无法看到doxygen生成的HTML文档

也许我可以做些什么cron-job,以保持服务器端的doxygen更新？

非常欢迎帮助.

Answer 1

我相信,一个人永远不能储存生成的文件在源代码库,特别是当它们是由就像doxygen从文件通常可用的工具产生的已存储在库中.在Doxygen的情况下,您只需要存储Doxyfile在回购中.

(或者,更好的是,如果您正在使用autoconf,则存储Doxyfile.in,以便将当前项目版本号替换为Doxyfile作为configure步骤的一部分生成的.)

如果您想确保检查项目的每个人都获得Doxygen生成的参考手册的副本,请将其作为默认构建过程的一部分.

Answer 2

我同意沃伦的观点，但我要补充以下内容：

每次推送到裸仓库时，您都可以使用“后接收挂钩”自动更新（单独的）工作目录。在http://toroid.org/ams/git-website-howto此处描述了这种方法用于维护版本控制的网站，我以这种方式使用它。

在我看来，您可以在更新之后添加一个步骤来运行Doxygen，这与您要查找的内容有关。如果Doxygen出现故障，您可能需要考虑如何向用户/提交者报告错误，但这是我看到的唯一问题。