taler-docs

commit dd6f90a40e6f8a600b465135de4ba3e9bc27e839
parent d3655485d040646ca1e063713590e515bdd93af2
Author: Thien-Thi Nguyen <ttn@gnuvola.org>
Date:   Sat, 20 Nov 2021 08:08:42 -0500

Document "make install" before "make check" quirk

* frags/install-before-check.rst: New.
* taler-auditor-manual.rst (Installing from source):
  Add ‘include::’ directive for new frag.
* taler-exchange-manual.rst (Installing from source): Likewise.
* taler-merchant-manual.rst (Installing the GNU Taler merchant backend): Likewise.

Diffstat:
A
frags/install-before-check.rst
 | 
10
++++++++++
M
taler-auditor-manual.rst
 | 
2
++
M
taler-exchange-manual.rst
 | 
2
++
M
taler-merchant-manual.rst
 | 
2
++

4 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/frags/install-before-check.rst b/frags/install-before-check.rst
@@ -0,0 +1,10 @@
+Please note that unlike most packages, if you want to run the ``make check``
+command, you should run it only *after* having done ``make install``.  The
+latter ensures that necessary binaries are copied to the right place.
+
+Gratuitous editorial note by TTN: I think this is a quirk that we should
+fix in the long-term as such weirdness might hide other build issues.
+However, this is probably a minority viewpoint.
+
+In any case, if ``make check`` fails, please consider filing a
+bug report with the Taler `bug tracker <https://bugs.taler.net>`__.
diff --git a/taler-auditor-manual.rst b/taler-auditor-manual.rst
@@ -201,6 +201,8 @@ the exchange (which includes the code for the auditor).
 
 .. include:: frags/installing-taler-exchange.rst
 
+.. include:: frags/install-before-check.rst
+
 
 Installing the GNU Taler binary packages on Debian
 --------------------------------------------------
diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst
@@ -313,6 +313,8 @@ the GNU Taler exchange from source.
 
 .. include:: frags/installing-taler-exchange.rst
 
+.. include:: frags/install-before-check.rst
+
 
 Installing the GNU Taler binary packages on Debian
 --------------------------------------------------
diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst
@@ -348,6 +348,8 @@ Installing the GNU Taler merchant backend
 
 .. include:: frags/installing-taler-merchant.rst
 
+.. include:: frags/install-before-check.rst
+
 
 Installing the GNU Taler binary packages on Debian
 --------------------------------------------------