]> git.ipfire.org Git - thirdparty/qemu.git/commitdiff
docs/devel/tracing: Update trace.h creation rune to include SPDX
authorPeter Maydell <peter.maydell@linaro.org>
Mon, 7 Jul 2025 14:49:17 +0000 (15:49 +0100)
committerMichael Tokarev <mjt@tls.msk.ru>
Sun, 13 Jul 2025 09:08:07 +0000 (12:08 +0300)
checkpatch now checks that new files have an SPDX line. If you use the
shell rune in tracing.rst to create a trace.h wrapper header, this
triggers checkpatch to complain.

Although these files are tiny, it's worth having the SPDX line to
avoid having to add extra exception cases to checkpatch.

Update the rune to include creating an SPDX line.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Michael Tokarev <mjt@tls.msk.ru>
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
docs/devel/tracing.rst

index 043bed7fd0fcbfd0dcdd5ad0edd2ec939a546288..f4557ee20e4b9111581e3e4d5287a59fd0f40a53 100644 (file)
@@ -76,7 +76,7 @@ The "io/trace.h" file must be created manually with an #include of the
 corresponding "trace/trace-<subdir>.h" file that will be generated in the
 builddir::
 
-  $ echo '#include "trace/trace-io.h"' >io/trace.h
+  $ (echo '/* SPDX-License-Identifier: GPL-2.0-or-later */' ; echo '#include "trace/trace-io.h"')  >io/trace.h
 
 While it is possible to include a trace.h file from outside a source file's own
 sub-directory, this is discouraged in general. It is strongly preferred that