From 6e16d7ac5bb86140a55ea30a35c69ee0df3eff8d Mon Sep 17 00:00:00 2001
From: Alejandro Colomar <alx@nginx.com>
Date: Wed, 22 Mar 2023 16:55:02 +0100
Subject: Auto: mirroring installation structure in build tree.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This makes the build tree more organized, which is good for adding new
stuff.  Now, it's useful for example for adding manual pages in man3/,
but it may be useful in the future for example for extending the build
system to run linters (e.g., clang-tidy(1), Clang analyzer, ...) on the
C source code.

Previously, the build tree was quite flat, and looked like this (after
`./configure && make`):

    $ tree -I src build
    build
    ├── Makefile
    ├── autoconf.data
    ├── autoconf.err
    ├── echo
    ├── libnxt.a
    ├── nxt_auto_config.h
    ├── nxt_version.h
    ├── unitd
    └── unitd.8

    1 directory, 9 files

And after this patch, it looks like this:

    $ tree -I src build
    build
    ├── Makefile
    ├── autoconf.data
    ├── autoconf.err
    ├── bin
    │   └── echo
    ├── include
    │   ├── nxt_auto_config.h
    │   └── nxt_version.h
    ├── lib
    │   ├── libnxt.a
    │   └── unit
    │       └── modules
    ├── sbin
    │   └── unitd
    ├── share
    │   └── man
    │       └── man8
    │           └── unitd.8
    └── var
        ├── lib
        │   └── unit
        ├── log
        │   └── unit
        └── run
            └── unit

    17 directories, 9 files

It also solves one issue introduced in
5a37171f733f ("Added default values for pathnames.").  Before that
commit, it was possible to run unitd from the build system
(`./build/unitd`).  Now, since it expects files in a very specific
location, that has been broken.  By having a directory structure that
mirrors the installation, it's possible to trick it to believe it's
installed, and run it from there:

    $ ./configure --prefix=./build
    $ make
    $ ./build/sbin/unitd

Fixes: 5a37171f733f ("Added default values for pathnames.")
Reported-by: Liam Crilly <liam@nginx.com>
Reviewed-by: Konstantin Pavlov <thresh@nginx.com>
Reviewed-by: Andrew Clayton <a.clayton@nginx.com>
Cc: Andrei Zeliankou <zelenkov@nginx.com>
Cc: Zhidao Hong <z.hong@f5.com>
Signed-off-by: Alejandro Colomar <alx@nginx.com>
---
 auto/echo/build | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'auto/echo')

diff --git a/auto/echo/build b/auto/echo/build
index d66c6951..b2396cd0 100644
--- a/auto/echo/build
+++ b/auto/echo/build
@@ -5,15 +5,15 @@
 
 $echo 'building an "echo" program'
 
-rm -f $NXT_BUILD_DIR/echo
+rm -f $NXT_BUILD_DIR/bin/echo
 
-nxt_echo_test="$CC -o $NXT_BUILD_DIR/echo -O $NXT_CC_OPT
+nxt_echo_test="$CC -o $NXT_BUILD_DIR/bin/echo -O $NXT_CC_OPT
                auto/echo/echo.c $NXT_LD_OPT"
 
 # "|| true" is to bypass "set -e" setting.
 nxt_echo_err=`$nxt_echo_test 2>&1 || true`
 
-if [ ! -x $NXT_BUILD_DIR/echo ]; then
+if [ ! -x $NXT_BUILD_DIR/bin/echo ]; then
     $echo
     $echo $0: error: cannot build an \"echo\" program:
     $echo
@@ -24,4 +24,4 @@ if [ ! -x $NXT_BUILD_DIR/echo ]; then
     exit 1
 fi
 
-echo=$NXT_BUILD_DIR/echo
+echo=$NXT_BUILD_DIR/bin/echo
-- 
cgit