git номер редакции в документации по исходному коду

Question

Я видел в нескольких проектах, что разработчики включают что-то вроде $Revision$ в документацию по исходному коду. Я думаю, что они являются макросами или переменными среды для какого-либо инструмента, но я не знаю, как с ними работать.

Мне интересно добавить эту функцию в мой следующий проект. Я обычно использую TextMate, Git и Doxygen. Есть предложения?

Answer 1

Да: предложение: не делайте этого.
Расширение ключевого слова может быть выполнено с помощью фильтра gitattribute, как представлено в " Git-эквиваленте расширения $ URL $ ключевого слова subversion ", но это вводит метаданныевнутри данных, что обычно делает слияние намного более сложным, чем они есть на самом деле.

Вы можете увидеть в этом (длинном) ответе на вопросе " Какие базовые концепции должны знать все разработчики? "все споры о" номерах встроенных версий - хороших или злых?".
Если у вас нет хорошего менеджера слияния, чтобы игнорировать эти специальные значения, вы получите" Ад слияния ".
А в Git, как описано в " Как Git решает проблему слияния? ", слияние является довольно простым.Нет фантазии менеджер слияний.

Answer 2

$Revision:$ (требуется ':') используется RCS и CVS.Некоторые другие системы имеют аналогичные функции, но, похоже, что более современные не имеют.