Received-SPF: pass (google.com: domain of linux-kernel+bounces-151635-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Fri, 19 Apr 2024 17:09:42 +0200
From: Nicolas Schier <nicolas@fjasle.eu>
To: Masahiro Yamada <masahiroy@kernel.org>
Cc: linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 4/4] kbuild: use $(src) instead of $(srctree)/$(src) for
 source directory
Message-ID: <ZiKJNrei7zUVaLkb@bergen.fjasle.eu>
References: <20240416121838.95427-1-masahiroy@kernel.org>
 <20240416121838.95427-5-masahiroy@kernel.org>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
	protocol="application/pgp-signature"; boundary="i0u71n+gDxHrlL+f"
Content-Disposition: inline
In-Reply-To: <20240416121838.95427-5-masahiroy@kernel.org>
Jabber-ID: nicolas@jabber.no


--i0u71n+gDxHrlL+f
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue 16 Apr 2024 21:18:38 GMT, Masahiro Yamada wrote:
> Kbuild conventionally uses $(obj)/ for generated files, and $(src)/ for
> checked-in source files. It is merely a convention without any functional
> difference. In fact, $(obj) and $(src) are exactly the same, as defined
> in scripts/Makefile.build:
>=20
>     src :=3D $(obj)
>=20
> When the kernel is built in a separate output directory, $(src) does
> not match the directory in the source tree. It still works because the
> top Makefile sets VPATH to $(srctree). However, VPATH does not cover
> all cases. There are many places where the exact path to the source
> directory is needed. For example, when adding a header search path for
> local headers, it is typical to pass -I$(srctree)/$(src) to the compiler.
>=20
> However, it introduces inconsistency between upstream Makefiles and
> downstream Makefiles; when the source directory path is needed,
> $(srctree)/$(src) is used in the upstream kernel, while $(src) is used
> in external modules.
>=20
> To resolve the distortion, this commit changes the semantics of $(src)
> so that it always points to the directory in the source tree.
>=20
> Going forward, the variables used in Makefiles will work as follows:
>=20
>   $(obj)     - directory in the object tree
>   $(src)     - directory in the source tree  (changed by this commit!)
>   $(objtree) - the top of the kernel object tree
>   $(srctree) - the top of the kernel source tree
>=20
> This is a tweewide Makefile conversion for replacing $(srctree)/$(src)
> with $(src).

tweewide -> treewide

[...]
> diff --git a/drivers/Makefile b/drivers/Makefile
> index 3bf5cab4b451..fe9ceb0d2288 100644
> --- a/drivers/Makefile
> +++ b/drivers/Makefile
> @@ -6,11 +6,6 @@
>  # Rewritten to use lists instead of if-statements.
>  #
> =20
> -# Some driver Makefiles miss $(srctree)/ for include directive.
> -ifdef building_out_of_srctree
> -MAKEFLAGS +=3D --include-dir=3D$(srctree)
> -endif
> -

Ah, it's nice to get rid of this.

>  obj-y				+=3D cache/
>  obj-y				+=3D irqchip/
>  obj-y				+=3D bus/
[...]
> diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib
> index 3179747cbd2c..c53d2f168801 100644
> --- a/scripts/Makefile.lib
> +++ b/scripts/Makefile.lib
> @@ -209,13 +209,13 @@ _c_flags +=3D $(if $(patsubst n%,, \
>  	-D__KCSAN_INSTRUMENT_BARRIERS__)
>  endif
> =20
> -# $(srctree)/$(src) for including checkin headers from generated source =
files
> -# $(objtree)/$(obj) for including generated headers from checkin source =
files
> +# $(src) for including checkin headers from generated source files
> +# $(obj) for including generated headers from checkin source files

this is a funny criss-cross of words; but might the following be more=20
accurate?

# $(src) for including headers from checked-in source files
# $(obj) for including generated headers


Anyway, thanks for the patch.  I think it is quite a good way forward!

Reviewed-by: Nicolas Schier <nicolas@fjasle.eu>

--i0u71n+gDxHrlL+f
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCAAdFiEEh0E3p4c3JKeBvsLGB1IKcBYmEmkFAmYiiTUACgkQB1IKcBYm
Emmj6Q//cIvEL5iZu7UNYQC1sjxZ7oCAdl9f00PUES61cSQj1fcrXxz2cEdStnOw
ZKYwn8tiprhRkLmfdX+udQUlVKXKCBXIAozpdH24w706YMfBiAbw7eOqfgIP302b
BNjhMc24saIePZPYNj2EVB1IrQYNrY+R7tfF8gOtON80TgGEMYoUp54NOlzZVGAp
E9zTI1LcU1jdNg2TXh5+cWw0INy5sIIy0McSG8jPwgV04HG722MrhH/NhoFZqOi3
ajLGhaNJLfa7Yb2WPHjEVS07z2hugQd7WYU1+Fx3uUO6N6ZoCDcwEDYTibDtotUb
nFtiUQGuHDLtUZo6QI/ZB/wH7dHKp36vQqo3X19CtZwf5relCASs2KtMp4chUoZM
0Ve/JKth7JfjMGKZAsF2yluujSNiieHrxQLROgEJxd79Sk25Ks6SDcL+Nb83TqOl
QwQ9qq2qwRat8rBjSHbNiDESAhvXybbbvl2aL4+k+HluyAs1m9zBxrHpjzM9xav0
bksXUfHxgNJrk6cpVg5Lk3w/EC01nSb6W/mPnWfGgMAa72Hzk21SDw8h4/fnGdxG
wHBq7WEsWRnLwZSXf0HLz+KJAPC6At2PLldq+d1w+HUEJwM4vOxwP8x9sUBaUycm
QmmZ0Rty83AkkZLb9ncIoBRdXYagH7SZXHzEOcztIyznp8zG/Mk=
=Txrt
-----END PGP SIGNATURE-----

--i0u71n+gDxHrlL+f--