Я использую yardдля генерации документации. моего проекта. Несмотря на то, что документация может быть сгенерирована и, следовательно, не нуждается в управлении версиями, мы решили сделать это, потому что так легче увидеть влияние изменений кода (комментариев) на реальную документацию.
Проблема заключается в том, что каждый раз, когда верфь создает документацию, она меняет дату в начале каждого файла, в результате чего все файлы рассматриваются как измененные.
Есть ли способ либо указать git игнорировать эту строку, чтобы определить, изменились ли файлы, либо, в качестве альтернативы, способ настроить yard, чтобы он не регенерировал файл, если они идентичны?
Спасибо
Я знаю, что могу написать скрипт или что-то в этом роде, который очищаетфайлы, если изменилась только дата. Итак, мой вопрос заключается в том, что есть способ сделать это с помощью Git, т.е. стоит ли мне читать о драйверах diff или делать чистый скрипт.
Если бы я пошел по пути очистки, было бы лучше сделать это с помощью git-хука или интегрировать его в генерацию документа.
В конечном счете, меня интересует любой другой способ отслеживать изменения, связанные с определенной фиксацией в сгенерированном документе.
Я толком не объяснил, в чем моя проблема (и почему я пытаюсь версионировать то, чего не должно быть), так что поехали.
Иногда небольшие изменения в коде портят документацию, поэтому я могу увидеть влияние коммита на документацию.
Пример: Я использую modeline для vim (комментарий в первой строке файла, сообщающий vim другую информацию)
Знайте, что у меня есть файл с документацией модуля
#vi: my vim setting
# Documentation of module A
module A
.... some code
end
И где-то еще я использую этот модуль
#vi : my vim setting
( 2 blank lines)
module A
.... some different code
end
В этот момент , все в порядке, и документация для A будет Documentation of module A
. Однако, если кто-то (например, я) удалит пустую строку в последнем файле и оставит только одну (да, я оставляю 2 пустые строки между моделью и кодом), то я думаю, что модель — это документация для модуля A, который будет vi : мои настройки vim
.
Проблема в том, что невозможно определить, что документ испорчен, кроме просмотра каждой отдельной страницы. Используя git, я могу быстро увидеть и проверить, что изменилось, и даже узнать, когда (что важно, потому что тогда я могу понять, почему это изменилось).