linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"H. Peter Anvin" <hpa@zytor.com>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	"Steven Rostedt (Google)" <rostedt@goodmis.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	Borislav Petkov <bp@alien8.de>,
	Dan Williams <dan.j.williams@intel.com>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	Ingo Molnar <mingo@redhat.com>,
	Isabella Basso <isabbasso@riseup.net>,
	Josh Poimboeuf <jpoimboe@kernel.org>,
	Kees Cook <keescook@chromium.org>,
	Masami Hiramatsu <mhiramat@kernel.org>,
	Miguel Ojeda <ojeda@kernel.org>, Miroslav Benes <mbenes@suse.cz>,
	Nathan Chancellor <nathan@kernel.org>,
	Peter Zijlstra <peterz@infradead.org>,
	Rasmus Villemoes <linux@rasmusvillemoes.dk>,
	Thomas Gleixner <tglx@linutronix.de>,
	Vlastimil Babka <vbabka@suse.cz>,
	linux-kernel@vger.kernel.org, x86@kernel.org
Subject: [PATCH v2 15/20] objtool: update objtool.txt references
Date: Sun, 26 Jun 2022 10:11:01 +0100	[thread overview]
Message-ID: <ec285ece6348a5be191aebe45f78d06b3319056b.1656234456.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1656234456.git.mchehab@kernel.org>

Changeset a8e35fece49b ("objtool: Update documentation")
renamed: tools/objtool/Documentation/stack-validation.txt
to: tools/objtool/Documentation/objtool.txt.

Update the cross-references accordingly.

Fixes: a8e35fece49b ("objtool: Update documentation")
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v2 00/20] at: https://lore.kernel.org/all/cover.1656234456.git.mchehab@kernel.org/

 Documentation/x86/orc-unwinder.rst | 2 +-
 include/linux/objtool.h            | 2 +-
 lib/Kconfig.debug                  | 2 +-
 tools/include/linux/objtool.h      | 2 +-
 tools/objtool/check.c              | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/x86/orc-unwinder.rst b/Documentation/x86/orc-unwinder.rst
index 9a66a88be765..cdb257015bd9 100644
--- a/Documentation/x86/orc-unwinder.rst
+++ b/Documentation/x86/orc-unwinder.rst
@@ -140,7 +140,7 @@ Unwinder implementation details
 
 Objtool generates the ORC data by integrating with the compile-time
 stack metadata validation feature, which is described in detail in
-tools/objtool/Documentation/stack-validation.txt.  After analyzing all
+tools/objtool/Documentation/objtool.txt.  After analyzing all
 the code paths of a .o file, it creates an array of orc_entry structs,
 and a parallel array of instruction addresses associated with those
 structs, and writes them to the .orc_unwind and .orc_unwind_ip sections
diff --git a/include/linux/objtool.h b/include/linux/objtool.h
index 15b940ec1eac..1c769cddb42a 100644
--- a/include/linux/objtool.h
+++ b/include/linux/objtool.h
@@ -62,7 +62,7 @@ struct unwind_hint {
  * It should only be used in special cases where you're 100% sure it won't
  * affect the reliability of frame pointers and kernel stack traces.
  *
- * For more information, see tools/objtool/Documentation/stack-validation.txt.
+ * For more information, see tools/objtool/Documentation/objtool.txt.
  */
 #define STACK_FRAME_NON_STANDARD(func) \
 	static void __used __section(".discard.func_stack_frame_non_standard") \
diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 3da5f9acb966..3025347bb433 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -498,7 +498,7 @@ config STACK_VALIDATION
 	  runtime stack traces are more reliable.
 
 	  For more information, see
-	  tools/objtool/Documentation/stack-validation.txt.
+	  tools/objtool/Documentation/objtool.txt.
 
 config NOINSTR_VALIDATION
 	bool
diff --git a/tools/include/linux/objtool.h b/tools/include/linux/objtool.h
index 15b940ec1eac..1c769cddb42a 100644
--- a/tools/include/linux/objtool.h
+++ b/tools/include/linux/objtool.h
@@ -62,7 +62,7 @@ struct unwind_hint {
  * It should only be used in special cases where you're 100% sure it won't
  * affect the reliability of frame pointers and kernel stack traces.
  *
- * For more information, see tools/objtool/Documentation/stack-validation.txt.
+ * For more information, see tools/objtool/Documentation/objtool.txt.
  */
 #define STACK_FRAME_NON_STANDARD(func) \
 	static void __used __section(".discard.func_stack_frame_non_standard") \
diff --git a/tools/objtool/check.c b/tools/objtool/check.c
index 864bb9dd3584..970844ceecdc 100644
--- a/tools/objtool/check.c
+++ b/tools/objtool/check.c
@@ -3190,7 +3190,7 @@ static struct instruction *next_insn_to_validate(struct objtool_file *file,
  * Follow the branch starting at the given instruction, and recursively follow
  * any other branches (jumps).  Meanwhile, track the frame pointer state at
  * each instruction and validate all the rules described in
- * tools/objtool/Documentation/stack-validation.txt.
+ * tools/objtool/Documentation/objtool.txt.
  */
 static int validate_branch(struct objtool_file *file, struct symbol *func,
 			   struct instruction *insn, struct insn_state state)
-- 
2.36.1


  parent reply	other threads:[~2022-06-26  9:11 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-26  9:10 [PATCH v2 00/20] Update Documentation/ cross-references Mauro Carvalho Chehab
2022-06-26  9:10 ` [PATCH v2 01/20] docs: netdev: update maintainer-netdev.rst reference Mauro Carvalho Chehab
2022-06-26  9:10 ` [PATCH v2 02/20] docs: filesystems: update netfs-api.rst reference Mauro Carvalho Chehab
2022-06-26  9:10 ` [PATCH v2 03/20] docs: zh_CN: page_frags.rst: fix a broken reference Mauro Carvalho Chehab
2022-06-27 14:52   ` YanTeng Si
2022-06-26  9:10 ` [PATCH v2 04/20] docs: zh_CN/riscv/pmu.rst: remove old docuementation Mauro Carvalho Chehab
2022-06-27 13:07   ` YanTeng Si
2022-06-26  9:10 ` [PATCH v2 05/20] docs: zh_CN/devicetree: fix typos Mauro Carvalho Chehab
2022-06-27 14:52   ` YanTeng Si
2022-06-26  9:10 ` [PATCH v2 06/20] docs: zh_CN: fix a broken reference Mauro Carvalho Chehab
2022-06-26  9:22   ` Miguel Ojeda
2022-06-26  9:10 ` [PATCH v2 07/20] docs: zh_CN/vm: fix a typo for page reporting ReST file Mauro Carvalho Chehab
2022-06-27 14:54   ` YanTeng Si
2022-06-26  9:10 ` [PATCH v2 08/20] docs: zh_CN/vm/zsmalloc.rst: fix a typo Mauro Carvalho Chehab
2022-06-27 14:55   ` YanTeng Si
2022-06-26  9:10 ` [PATCH v2 09/20] docs: zh_CN/vm/index.rst: fix a broken reference Mauro Carvalho Chehab
2022-06-27 13:14   ` YanTeng Si
2022-06-26  9:10 ` [PATCH v2 10/20] Documentation: update watch_queue.rst references Mauro Carvalho Chehab
2022-06-26 15:49   ` Randy Dunlap
2022-06-26  9:10 ` [PATCH v2 11/20] Documentation: KVM: update s390-pv.rst reference Mauro Carvalho Chehab
2022-06-26  9:10 ` [PATCH v2 12/20] Documentation: KVM: update amd-memory-encryption.rst references Mauro Carvalho Chehab
2022-06-26  9:10 ` [PATCH v2 13/20] Documentation: KVM: update msr.rst reference Mauro Carvalho Chehab
2022-06-26  9:11 ` [PATCH v2 14/20] Documentation: KVM: update s390-diag.rst reference Mauro Carvalho Chehab
2022-06-26  9:11 ` Mauro Carvalho Chehab [this message]
2022-06-26  9:11 ` [PATCH v2 16/20] arch: m68k: q40: README: drop references to IDE driver Mauro Carvalho Chehab
2022-06-26  9:14   ` Geert Uytterhoeven
2022-06-26  9:11 ` [PATCH v2 17/20] tegra194-hte.rst: fix reference to its binding Mauro Carvalho Chehab
2022-06-27 17:14   ` Dipen Patel
2022-07-06 21:38     ` Thierry Reding
2022-06-26  9:11 ` [PATCH v2 18/20] dt-bindings: mfd: update dlg,da9063.yaml reference Mauro Carvalho Chehab
2022-06-26 11:10   ` Conor.Dooley
2022-06-30 23:14   ` Rob Herring
2022-06-26  9:11 ` [PATCH v2 19/20] MAINTAINERS: update nvidia,tegra20-host1x.yaml reference Mauro Carvalho Chehab
2022-06-26  9:11 ` [PATCH v2 20/20] MAINTAINERS: fix cross references to mfd/dlg,da9063.yaml Mauro Carvalho Chehab
2022-06-26 11:19   ` Conor.Dooley
2022-07-07 19:12 ` [PATCH v2 00/20] Update Documentation/ cross-references Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ec285ece6348a5be191aebe45f78d06b3319056b.1656234456.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=dan.j.williams@intel.com \
    --cc=dave.hansen@linux.intel.com \
    --cc=hpa@zytor.com \
    --cc=isabbasso@riseup.net \
    --cc=jpoimboe@kernel.org \
    --cc=keescook@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@rasmusvillemoes.dk \
    --cc=mbenes@suse.cz \
    --cc=mchehab+huawei@kernel.org \
    --cc=mhiramat@kernel.org \
    --cc=mingo@redhat.com \
    --cc=nathan@kernel.org \
    --cc=ojeda@kernel.org \
    --cc=peterz@infradead.org \
    --cc=rostedt@goodmis.org \
    --cc=tglx@linutronix.de \
    --cc=vbabka@suse.cz \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).