[PATCH 0/3] align custom kbuild messages to standard layout

[PATCH 0/3] align custom kbuild messages to standard layout

[Thomas Weißschuh]

The common layout for kbuild messages is as follows:

- 2 spaces
- 7 or more characters for the action
- 1 space
- name of the file being built/generated

The custom message formatting included an additional space in the action
part, which leads to misalignments with the rest of kbuild.

To: Alexei Starovoitov <ast@kernel.org>
To: Daniel Borkmann <daniel@iogearbox.net>
To: Andrii Nakryiko <andrii@kernel.org>
To: Martin KaFai Lau <martin.lau@linux.dev>
To: Song Liu <song@kernel.org>
To: Yonghong Song <yhs@fb.com>
To: John Fastabend <john.fastabend@gmail.com>
To: KP Singh <kpsingh@kernel.org>
To: Stanislav Fomichev <sdf@google.com>
To: Hao Luo <haoluo@google.com>
To: Jiri Olsa <jolsa@kernel.org>
To: Mykola Lysenko <mykolal@fb.com>
To: Shuah Khan <shuah@kernel.org>
Cc: bpf@vger.kernel.org
Cc: linux-kselftest@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
To: Masahiro Yamada <masahiroy@kernel.org>
Cc: linux-kbuild@vger.kernel.org
Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>

---
Thomas Weißschuh (3):
      selftests/bpf: align kbuild messages to standard
      bpf: iterators: align kbuild messages to standard
      tools/resolve_btfids: align kbuild messages to standard

 kernel/bpf/preload/iterators/Makefile | 2 +-
 tools/bpf/resolve_btfids/Makefile     | 2 +-
 tools/testing/selftests/bpf/Makefile  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
---
base-commit: c1649ec55708ae42091a2f1bca1ab49ecd722d55
change-id: 20230118-kbuild-alignment-ca1ce98ea566

Best regards,
-- 
Thomas Weißschuh <linux@weissschuh.net>

[PATCH 1/3] selftests/bpf: align kbuild messages to standard

[Thomas Weißschuh]

The common layout for kbuild messages is as follows:

- 2 spaces
- 7 or more characters for the action
- 1 space
- name of the file being built/generated

The custom message formatting included an additional space in the action
part, which leads to misalignments with the rest of kbuild.

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 tools/testing/selftests/bpf/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/testing/selftests/bpf/Makefile b/tools/testing/selftests/bpf/Makefile
index c22c43bbee19..5190c19295d4 100644
--- a/tools/testing/selftests/bpf/Makefile
+++ b/tools/testing/selftests/bpf/Makefile
@@ -98,7 +98,7 @@ Q =
 msg =
 else
 Q = @
-msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
+msg = @printf '  %-7s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
 MAKEFLAGS += --no-print-directory
 submake_extras := feature_display=0
 endif

-- 
2.39.1

Re: [PATCH 1/3] selftests/bpf: align kbuild messages to standard

[Yonghong Song]

On 1/17/23 7:52 PM, Thomas Weißschuh wrote:
> The common layout for kbuild messages is as follows:
> 
> - 2 spaces
> - 7 or more characters for the action
> - 1 space
> - name of the file being built/generated
> 
> The custom message formatting included an additional space in the action
> part, which leads to misalignments with the rest of kbuild.

Could you give an example to show the output before/after the patch, and
how it leads to mis-alignment and why it is a problem?

> 
> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
> ---
>   tools/testing/selftests/bpf/Makefile | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tools/testing/selftests/bpf/Makefile b/tools/testing/selftests/bpf/Makefile
> index c22c43bbee19..5190c19295d4 100644
> --- a/tools/testing/selftests/bpf/Makefile
> +++ b/tools/testing/selftests/bpf/Makefile
> @@ -98,7 +98,7 @@ Q =
>   msg =
>   else
>   Q = @
> -msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
> +msg = @printf '  %-7s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
>   MAKEFLAGS += --no-print-directory
>   submake_extras := feature_display=0
>   endif
> 

Re: [PATCH 1/3] selftests/bpf: align kbuild messages to standard

[Thomas Weißschuh]

On Tue, Jan 17, 2023 at 09:02:20PM -0800, Yonghong Song wrote:
> 
> 
> On 1/17/23 7:52 PM, Thomas Weißschuh wrote:
> > The common layout for kbuild messages is as follows:
> > 
> > - 2 spaces
> > - 7 or more characters for the action
> > - 1 space
> > - name of the file being built/generated
> > 
> > The custom message formatting included an additional space in the action
> > part, which leads to misalignments with the rest of kbuild.
> 
> Could you give an example to show the output before/after the patch, and
> how it leads to mis-alignment and why it is a problem?

Before:

  LD      .../linux/tools/bpf/resolve_btfids/resolve_btfids-in.o
  LINK     resolve_btfids
  CHK     kernel/kheaders_data.tar.xz

After:

  LD      .../linux/tools/bpf/resolve_btfids/resolve_btfids-in.o
  LINK    resolve_btfids
  CHK     kernel/kheaders_data.tar.xz

The line starting with "LINK" has the filename "resolve_btfids" one
space character more to the right than the other lines.

It's slightly confusing when scanning the build logs.

> > Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
> > ---
> >   tools/testing/selftests/bpf/Makefile | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/tools/testing/selftests/bpf/Makefile b/tools/testing/selftests/bpf/Makefile
> > index c22c43bbee19..5190c19295d4 100644
> > --- a/tools/testing/selftests/bpf/Makefile
> > +++ b/tools/testing/selftests/bpf/Makefile
> > @@ -98,7 +98,7 @@ Q =
> >   msg =
> >   else
> >   Q = @
> > -msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
> > +msg = @printf '  %-7s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
> >   MAKEFLAGS += --no-print-directory
> >   submake_extras := feature_display=0
> >   endif
> > 

Re: [PATCH 1/3] selftests/bpf: align kbuild messages to standard

[Yonghong Song]

On 1/17/23 9:15 PM, Thomas Weißschuh wrote:
> On Tue, Jan 17, 2023 at 09:02:20PM -0800, Yonghong Song wrote:
>>
>>
>> On 1/17/23 7:52 PM, Thomas Weißschuh wrote:
>>> The common layout for kbuild messages is as follows:
>>>
>>> - 2 spaces
>>> - 7 or more characters for the action
>>> - 1 space
>>> - name of the file being built/generated
>>>
>>> The custom message formatting included an additional space in the action
>>> part, which leads to misalignments with the rest of kbuild.
>>
>> Could you give an example to show the output before/after the patch, and
>> how it leads to mis-alignment and why it is a problem?
> 
> Before:
> 
>    LD      .../linux/tools/bpf/resolve_btfids/resolve_btfids-in.o
>    LINK     resolve_btfids
>    CHK     kernel/kheaders_data.tar.xz
> 
> After:
> 
>    LD      .../linux/tools/bpf/resolve_btfids/resolve_btfids-in.o
>    LINK    resolve_btfids
>    CHK     kernel/kheaders_data.tar.xz
> 
> The line starting with "LINK" has the filename "resolve_btfids" one
> space character more to the right than the other lines.

Thanks! I would be great if you can put the details about
   (1) what are the command line to reproduce the issue, and
   (2) what the output differences,
to the commit message in all three patches.

> 
> It's slightly confusing when scanning the build logs.
> 
>>> Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
>>> ---
>>>    tools/testing/selftests/bpf/Makefile | 2 +-
>>>    1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/tools/testing/selftests/bpf/Makefile b/tools/testing/selftests/bpf/Makefile
>>> index c22c43bbee19..5190c19295d4 100644
>>> --- a/tools/testing/selftests/bpf/Makefile
>>> +++ b/tools/testing/selftests/bpf/Makefile
>>> @@ -98,7 +98,7 @@ Q =
>>>    msg =
>>>    else
>>>    Q = @
>>> -msg = @printf '  %-8s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
>>> +msg = @printf '  %-7s%s %s%s\n' "$(1)" "$(if $(2), [$(2)])" "$(notdir $(3))" "$(if $(4), $(4))";
>>>    MAKEFLAGS += --no-print-directory
>>>    submake_extras := feature_display=0
>>>    endif
>>>

[PATCH 2/3] bpf: iterators: align kbuild messages to standard

[Thomas Weißschuh]

The common layout for kbuild messages is as follows:

- 2 spaces
- 7 or more characters for the action
- 1 space
- name of the file being built/generated

The custom message formatting included an additional space in the action
part, which leads to misalignments with the rest of kbuild.

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 kernel/bpf/preload/iterators/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/bpf/preload/iterators/Makefile b/kernel/bpf/preload/iterators/Makefile
index 6762b1260f2f..7c6bb9d010ca 100644
--- a/kernel/bpf/preload/iterators/Makefile
+++ b/kernel/bpf/preload/iterators/Makefile
@@ -26,7 +26,7 @@ Q =
 msg =
 else
 Q = @
-msg = @printf '  %-8s %s%s\n' "$(1)" "$(notdir $(2))" "$(if $(3), $(3))";
+msg = @printf '  %-7s %s%s\n' "$(1)" "$(notdir $(2))" "$(if $(3), $(3))";
 MAKEFLAGS += --no-print-directory
 submake_extras := feature_display=0
 endif

-- 
2.39.1

[PATCH 3/3] tools/resolve_btfids: align kbuild messages to standard

[Thomas Weißschuh]

The common layout for kbuild messages is as follows:

- 2 spaces
- 7 or more characters for the action
- 1 space
- name of the file being built/generated

The custom message formatting included an additional space in the action
part, which leads to misalignments with the rest of kbuild.

Signed-off-by: Thomas Weißschuh <linux@weissschuh.net>
---
 tools/bpf/resolve_btfids/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/bpf/resolve_btfids/Makefile b/tools/bpf/resolve_btfids/Makefile
index 19a3112e271a..f4106d514b9c 100644
--- a/tools/bpf/resolve_btfids/Makefile
+++ b/tools/bpf/resolve_btfids/Makefile
@@ -12,7 +12,7 @@ else
   ifeq ($(silent),1)
     msg =
   else
-    msg = @printf '  %-8s %s%s\n' "$(1)" "$(notdir $(2))" "$(if $(3), $(3))";
+    msg = @printf '  %-7s %s%s\n' "$(1)" "$(notdir $(2))" "$(if $(3), $(3))";
   endif
   MAKEFLAGS=--no-print-directory
 endif

-- 
2.39.1