devtools: forbid writing to standard output streams
Checks
Commit Message
No output on stdout or stderr!
Drivers and libraries must use the logging framework.
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
devtools/checkpatches.sh | 8 ++++++++
1 file changed, 8 insertions(+)
Comments
On Thu, Dec 21, 2023 at 02:31:20PM +0100, David Marchand wrote:
> No output on stdout or stderr!
> Drivers and libraries must use the logging framework.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> devtools/checkpatches.sh | 8 ++++++++
> 1 file changed, 8 insertions(+)
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
On Thu, 21 Dec 2023 14:31:20 +0100
David Marchand <david.marchand@redhat.com> wrote:
> No output on stdout or stderr!
> Drivers and libraries must use the logging framework.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> devtools/checkpatches.sh | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
> index 10d1bf490b..c9e466f736 100755
> --- a/devtools/checkpatches.sh
> +++ b/devtools/checkpatches.sh
> @@ -61,6 +61,14 @@ check_forbidden_additions() { # <patch>
> -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
> "$1" || res=1
>
> + # no output on stdout or stderr
> + awk -v FOLDERS="lib drivers" \
> + -v EXPRESSIONS="\\\<printf\\\> \\\<fprintf\\\(stdout, \\\<fprintf\\\(stderr," \
> + -v RET_ON_FAIL=1 \
> + -v MESSAGE='Writing to stdout or stderr' \
> + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
> + "$1" || res=1
> +
> # refrain from new additions of rte_panic() and rte_exit()
> # multiple folders and expressions are separated by spaces
> awk -v FOLDERS="lib drivers" \
Ok, noticed a lot of this in the crypto drivers dump code.
Probably other drivers have buried debug code as well.
On Thu, Dec 21, 2023 at 02:31:20PM +0100, David Marchand wrote:
> No output on stdout or stderr!
> Drivers and libraries must use the logging framework.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
Acked-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
On Thu, Dec 21, 2023 at 2:31 PM David Marchand
<david.marchand@redhat.com> wrote:
>
> No output on stdout or stderr!
> Drivers and libraries must use the logging framework.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
Applied, thanks.
@@ -61,6 +61,14 @@ check_forbidden_additions() { # <patch>
-f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
"$1" || res=1
+ # no output on stdout or stderr
+ awk -v FOLDERS="lib drivers" \
+ -v EXPRESSIONS="\\\<printf\\\> \\\<fprintf\\\(stdout, \\\<fprintf\\\(stderr," \
+ -v RET_ON_FAIL=1 \
+ -v MESSAGE='Writing to stdout or stderr' \
+ -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+ "$1" || res=1
+
# refrain from new additions of rte_panic() and rte_exit()
# multiple folders and expressions are separated by spaces
awk -v FOLDERS="lib drivers" \