]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
Don’t update author list when generating documentation
authorJoel Rosdahl <joel@rosdahl.net>
Sun, 14 Jun 2020 18:59:13 +0000 (20:59 +0200)
committerJoel Rosdahl <joel@rosdahl.net>
Wed, 17 Jun 2020 07:10:09 +0000 (09:10 +0200)
Motivation:

1. The copyright notice in each source file refers to doc/AUTHORS.adoc
   for the list of contributors. If we only update AUTHORS.adoc when
   generating documention then AUTHORS.adoc will become more and more
   out of date until somebody remembers to commit the changes.
2. The list is based on commit authors, but authors may sometimes need
   an entry in .mailmap so there’s manual work involved to sanity check
   the list. It can also happen that some commits or authors may need to
   be excluded.

Therefore I prefer to keep AUTHORS.adoc manually updated at release time
(or occasionally more often) with the help of a script just like before.

CMakeLists.txt
doc/CMakeLists.txt

index c124fd4a7ce3487db9e9f8c27892dc654a387413..978b949ea5714e41f728a3d1e64d0ded577b857b 100644 (file)
@@ -73,10 +73,6 @@ add_subdirectory(doc)
 include(GNUInstallDirs)
 install(TARGETS ccache DESTINATION ${CMAKE_INSTALL_BINDIR})
 
-# before adding documentation to package run misc/update_authors.sh
-#
-# install(TARGETS documentation DESTINATION ${CMAKE_INSTALL_DOCDIR})
-
 #
 # packaging
 #
index 3ecef50b6a73825453a52fc31df9d4a8f1d451a9..5117ff6307433a0bf23c1f5639a9ac4fbc909011 100644 (file)
@@ -20,7 +20,6 @@ else()
   add_custom_command (
     TARGET documentation
     COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_BINARY_DIR}/doc"
-    COMMAND misc/update_authors.sh
     BYPRODUCTS "doc"
     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
   )