Jak zminimalizować liczbę zmian między wersjami z nowym wyjściem doxygen?

Question

Repozytorium subversion zawiera katalogi html, latex i man, które doxygen generuje z kodu źródłowego. Nawet w przypadku małych zmian kodu źródłowego tworzone są nowe pliki o losowych nazwach, co powoduje duże zmiany w systemie kontroli wersji.

Czy istnieje sposób obejścia tego? W jaki sposób mogę zminimalizować zmiany między wersjami, nadal zawierając dokumentację generowaną przez doxygen? Alternatywnie, jak mogę znaleźć, który z plików z oznaczeniem doksygenowym nie jest już używany i powinien zostać usunięty?

Answer 1

Nienawidzę odpowiadać na pytania bez udzielania odpowiedzi na konkretne pytanie, ale generalnie złym pomysłem jest śledzenie doxygen docs w repozytorium. To samo dotyczy skryptów konfiguracyjnych generowanych przez autoconf.

Jeśli martwisz się o ludzi, którzy nie mogą generować dokumentów z powodu braku doxygenu, lepiej jest go używać we własnym prywatnym repozytorium w Twoim języku i wybranym miejscu.

Można modyfikować skrypty budowania, aby wykonać to dla użytkownika, bez większego wysiłku. Z mojego doświadczenia wynikającego z wieloletniej pracy nad oprogramowaniem wolnym/otwartym, ci, którzy naprawdę dbają o dokumenty, będą w stanie je wygenerować .. ale twój przebieg może się różnić.

eliminując zbędne konflikty scalania (czyli Joe zmienił komentarzy I docs i teraz musi scalić oba) IMHO uzasadnia uzewnętrzniania wygenerowane dokumenty.