From 658daae34aa3b2b40e6473d44d41abcf175f1ab2 Mon Sep 17 00:00:00 2001
From: Werner Koch <wk@gnupg.org>
Date: Tue, 21 Mar 2023 09:15:20 +0100
Subject: [PATCH] doc: Suggest the use of out-of-source builds.

--

GnuPG-bug-id:  6313
---
 INSTALL | 28 ++++++++++++++++------------
 README  |  7 +++++--
 2 files changed, 21 insertions(+), 14 deletions(-)

diff --git a/INSTALL b/INSTALL
index 5458714e1..9e9642898 100644
--- a/INSTALL
+++ b/INSTALL
@@ -42,10 +42,12 @@ may remove or edit it.
 you want to change it or regenerate `configure' using a newer version
 of `autoconf'.
 
-The simplest way to compile this package is:
+The suggested way to compile this package is:
 
-  1. `cd' to the directory containing the package's source code and type
-     `./configure' to configure the package for your system.
+  1. `cd' to the directory containing the package's source code and
+     create a new directory named `build'.  Then `cd' to that
+     directory and type `../configure' to configure the package for
+     your system.
 
      Running `configure' might take a while.  While running, it prints
      some messages telling which features it is checking for.
@@ -58,14 +60,17 @@ The simplest way to compile this package is:
   4. Type `make install' to install the programs and any data files and
      documentation.
 
-  5. You can remove the program binaries and object files from the
-     source code directory by typing `make clean'.  To also remove the
-     files that `configure' created (so you can compile the package for
-     a different kind of computer), type `make distclean'.  There is
-     also a `make maintainer-clean' target, but that is intended mainly
-     for the package's developers.  If you use it, you may have to get
-     all sorts of other programs in order to regenerate files that came
-     with the distribution.
+  5. You can remove the program binaries and object files by deleting
+     all files from the `build' directory.  In case you did not used a
+     dedicated build directory but build the software directly in the
+     source tree, you can remove the program binaries and object files
+     from the source code directory by typing `make clean'.  To also
+     remove the files that `configure' created (so you can compile the
+     package for a different kind of computer), type `make distclean'.
+     There is also a `make maintainer-clean' target, but that is
+     intended mainly for the package's developers.  If you use it, you
+     may have to get all sorts of other programs in order to
+     regenerate files that came with the distribution.
 
 Compilers and Options
 =====================
@@ -231,4 +236,3 @@ an Autoconf bug.  Until the bug is fixed you can use this workaround:
 
 `configure' also accepts some other, not widely useful, options.  Run
 `configure --help' for more details.
-
diff --git a/README b/README
index 42eed238f..b9bf7805e 100644
--- a/README
+++ b/README
@@ -53,7 +53,9 @@
 
   As with all packages, you just have to do
 
-    ./configure
+    mkdir build
+    cd build
+    ../configure
     make
     make check
     make install
@@ -81,7 +83,8 @@
   To quickly build all required software without installing it, the
   Speedo method may be used:
 
-    make -f build-aux/speedo.mk  native
+    cd build
+    make -f ../build-aux/speedo.mk  native
 
   This method downloads all required libraries and does a native build
   of GnuPG to PLAY/inst/.  GNU make is required and you need to set