From: David Wells <drwells@email.unc.edu>
Date: Tue, 24 Jul 2018 15:28:00 +0000 (-0400)
Subject: Improve generate_lapack_templates' documentation.
X-Git-Tag: v9.1.0-rc1~894^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F6963%2Fhead;p=dealii.git

Improve generate_lapack_templates' documentation.
---

diff --git a/contrib/utilities/generate_lapack_templates b/contrib/utilities/generate_lapack_templates
index c012707b6e..af3e009e7e 100755
--- a/contrib/utilities/generate_lapack_templates
+++ b/contrib/utilities/generate_lapack_templates
@@ -484,7 +484,14 @@ def main():
     """Determine the subroutines and then print needed declarations and definitions
     to the header.
     """
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(
+        description=("Automatically generate deal.II-compatible template BLAS "
+                     + "and LAPACK wrappers by parsing the documentation provided "
+                     + " by each library. The best way to get this documentation "
+                     + "is to clone the LAPACK development sources available at "
+                     + "https://github.com/Reference-LAPACK and then pass the "
+                     + "root directory location to this program with the "
+                     + "--lapack-root-directory option."))
     lapack_subroutines = list()
     blas_subroutines = list()
     fp_guarded_subroutines = list()