Improve _autoconf.py comments
authorIustin Pop <iustin@google.com>
Sun, 14 Dec 2008 12:04:20 +0000 (12:04 +0000)
committerIustin Pop <iustin@google.com>
Sun, 14 Dec 2008 12:04:20 +0000 (12:04 +0000)
This adds a docstring to the _autoconf.py file detailing how it's
generated (the other comment it's not visible in pydoc/epydoc).

Reviewed-by: amishchenko

Makefile.am

index 01df96a..85a114b 100644 (file)
@@ -269,6 +269,15 @@ lib/_autoconf.py: Makefile stamp-directories
        set -e; \
        { echo '# This file is automatically generated, do not edit!'; \
          echo '#'; \
+         echo ''; \
+         echo '"""Build-time configuration for Ganeti.'; \
+         echo '';\
+         echo 'This file is autogenerated by the build process.'; \
+         echo 'For any changes you need to re-run ./configure (and'; \
+         echo 'not edit by hand).'; \
+         echo ''; \
+         echo '"""'; \
+         echo ''; \
          echo "PACKAGE_VERSION = '$(PACKAGE_VERSION)'"; \
          echo "VERSION_MAJOR = '$(VERSION_MAJOR)'"; \
          echo "VERSION_MINOR = '$(VERSION_MINOR)'"; \