Doxygen для проекта, управляемого с git?
Я работаю над проектом 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 на стороне сервера ?
помощь очень приветствуется.
3 ответов
Я считаю, что никогда не следует хранить сгенерированные файлы в исходном репозитории, особенно когда они генерируются общедоступными инструментами, такими как Doxygen из файлов, которые are уже хранится в репозитории. В случае Doxygen, вам нужно только хранить Doxyfile в репо.
(или, лучше, если вы используете autoconf для, магазин Doxyfile.in, чтобы текущий номер версии проекта был заменен на сгенерированный Doxyfile в рамках configure шаг.)
если вы хотите убедиться, что каждый, кто проверяет ваш проект, получает копию справочного руководства Doxygen, сделайте его частью процесса сборки по умолчанию.
Я согласен с Уорреном, но я бы добавил следующее:
вы можете использовать "post-receive hook" для автоматического обновления (отдельного) рабочего каталога каждый раз, когда есть толчок к голому репозиторию. Этот подход описан для поддержания веб-сайтов, контролируемых версиями здесь http://toroid.org/ams/git-website-howto, и я использую его таким образом.
Мне кажется разумным, что вы можете добавить шаг к крючку для запуска Doxygen после обновления, которое примерно то, что ты ищешь. Возможно, нужно думать о том, как сообщать об ошибках пользователя/коммиттер при помощи Doxygen боркс, но это единственная проблема, которую я вижу.
Проверьте только конфигурационный файл doxygen,
получите ваш непрерывная интеграция сервер, чтобы создать документацию и опубликовать ее на внутреннем доступном веб-сайте и поделиться url-адресом с командой.