用于本地回购的 Doxygen

Question

目前，我在远程服务器中有一个没有详细记录的代码存储库，名为“A”。
我有它的本地克隆，称为''B''。

我想陪以下两件事：

1. 将 Doxygen 样式的 cmets 添加到 ''B'' 以生成文档。
2. 将变更集推送到 ''A''，而 ''B'' 中没有这些 cmets。

设置回购/分支以实现这一目标的最佳方式是什么？

Answer 1

您可以在B 中设置第二个分支：

• 可用于合并B的主分支，其中添加了那些Doxygen风格的注释（即：从主分支合并到第二个分支）
• 但有一个激活smudge content filter driver 的配置，smudge 是一个删除所有 Doxygen cmets 的脚本（也就是说，如果这些 cmets 易于解析和检测）

^{（图片来自“Customizing Git - Git Attributes”，来自“Pro Git book”）}

这涉及到一个.gitattributes 文件（仅存在于第二个分支中）

*.cpp filter=removeDoxygen

（将 cpp 替换为您的项目源代码的正确扩展名）

这涉及到本地配置：

 git config filter.removeDoxygen.smudge 'removeDoxygen'

removeDoxygen 是 $PATH 中任意位置的 shell 脚本。
（即使在 Windows 上也可以是一个 shell 脚本，因为它将由 msysgit shell 执行）

该合并将导致文件自动修改（通过smudge 脚本），并且需要在第二个分支中添加和提交。

然后将第二个分支推送到 repo A。