summary refs log tree commit diff stats
path: root/docs/devel
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2025-07-07 15:49:17 +0100
committerMichael Tokarev <mjt@tls.msk.ru>2025-07-13 12:08:07 +0300
commit0f55ca43cd90eb89193bae45d0907c1b17a1dadd (patch)
treef992401f69b84504444d06c40c1f6d13fb29d035 /docs/devel
parent21f4c5a700394878a6028708be480e73d8bea890 (diff)
downloadfocaccia-qemu-0f55ca43cd90eb89193bae45d0907c1b17a1dadd.tar.gz
focaccia-qemu-0f55ca43cd90eb89193bae45d0907c1b17a1dadd.zip
docs/devel/tracing: Update trace.h creation rune to include SPDX
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>
Diffstat (limited to 'docs/devel')
-rw-r--r--docs/devel/tracing.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/devel/tracing.rst b/docs/devel/tracing.rst
index 043bed7fd0..f4557ee20e 100644
--- a/docs/devel/tracing.rst
+++ b/docs/devel/tracing.rst
@@ -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