summaryrefslogtreecommitdiff
path: root/tools/objtool/Documentation/objtool.txt
diff options
context:
space:
mode:
authorJosh Poimboeuf <jpoimboe@kernel.org>2023-04-18 14:27:48 -0700
committerJosh Poimboeuf <jpoimboe@kernel.org>2023-05-16 06:31:51 -0700
commitca653464dd097fe64e69f1735e9f348b2a0f8037 (patch)
tree0d1f42b5efb9e2f46957e590f79b2062cdb5619e /tools/objtool/Documentation/objtool.txt
parent5e3992fe72748ed3892be876f09d4d990548b7af (diff)
objtool: Add verbose option for disassembling affected functions
When a warning is associated with a function, add an option to disassemble that function. This makes it easier for reporters to submit the information needed to diagnose objtool warnings. Reviewed-by: Miroslav Benes <mbenes@suse.cz> Link: https://lore.kernel.org/r/dd0fe13428ede186f09c74059a8001f4adcea5fc.1681853186.git.jpoimboe@kernel.org Signed-off-by: Josh Poimboeuf <jpoimboe@kernel.org>
Diffstat (limited to 'tools/objtool/Documentation/objtool.txt')
-rw-r--r--tools/objtool/Documentation/objtool.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/tools/objtool/Documentation/objtool.txt b/tools/objtool/Documentation/objtool.txt
index 744db4218e7a..8db1f29bf432 100644
--- a/tools/objtool/Documentation/objtool.txt
+++ b/tools/objtool/Documentation/objtool.txt
@@ -244,6 +244,11 @@ To achieve the validation, objtool enforces the following rules:
Objtool warnings
----------------
+NOTE: When requesting help with an objtool warning, please recreate with
+OBJTOOL_VERBOSE=1 (e.g., "make OBJTOOL_VERBOSE=1") and send the full
+output, including any disassembly below the warning, to the objtool
+maintainers.
+
For asm files, if you're getting an error which doesn't make sense,
first make sure that the affected code follows the above rules.