kbuild: doc: replace arch/$(ARCH)/ with arch/$(SRCARCH)/
authorMasahiro Yamada <masahiroy@kernel.org>
Sat, 28 Nov 2020 11:51:03 +0000 (20:51 +0900)
committerMasahiro Yamada <masahiroy@kernel.org>
Mon, 21 Dec 2020 04:56:58 +0000 (13:56 +0900)
commit8c4d9b145ba39fa31fd225e9051dd562260b6460
tree84bbeaa75e8d0e137d4ef486c0e5fa0359405fd2
parentb044a535d9a6873a21d622934228cfcc6ee4ea27
kbuild: doc: replace arch/$(ARCH)/ with arch/$(SRCARCH)/

Precisely speaking, the arch directory is specified by $(SRCARCH),
not $(ARCH).

In old days, $(ARCH) actually matched to the arch directory because
32-bit and 64-bit were supported as separate architectures.

Most architectures (except arm/arm64) were unified like follows:

    arch/i386, arch/x86_64    ->  arch/x86
    arch/sh, arch/sh64        ->  arch/sh
    arch/sparc, arch/sparc64  ->  arch/sparc

To not break the user interface, commit 6752ed90da03 ("Kbuild: allow
arch/xxx to use a different source path") introduced SRCARCH to point
to the arch directory, still allowing to pass in the former ARCH=i386
or ARCH=x86_64.

Update the documents for preciseness, and add the explanation of SRCARCH.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Documentation/kbuild/makefiles.rst
Documentation/kbuild/modules.rst