diff mbox series

[2/3] objtool: move stack-validation.txt to Documentation/

Message ID 1551764896-8453-2-git-send-email-yamada.masahiro@socionext.com
State New
Headers show
Series [1/3] tools: move initial declarations out of 'for' loop | expand

Commit Message

Masahiro Yamada March 5, 2019, 5:48 a.m. UTC
Move the document to the standard Documentation/ directory instead of
creating the same directory structure under objtool/.

Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>

---

 {tools/objtool/Documentation => Documentation}/stack-validation.txt | 0
 Documentation/x86/orc-unwinder.txt                                  | 2 +-
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename {tools/objtool/Documentation => Documentation}/stack-validation.txt (100%)

-- 
2.7.4

Comments

Jonathan Corbet March 5, 2019, 2:44 p.m. UTC | #1
On Tue,  5 Mar 2019 14:48:15 +0900
Masahiro Yamada <yamada.masahiro@socionext.com> wrote:

> Move the document to the standard Documentation/ directory instead of

> creating the same directory structure under objtool/.


This seems like a good idea to me, but can I make a couple of requests?

 - Convert it to RST while you're at it?  It's 99% there already.

 - Let's not add it to the top-level Documentation/ mess; I'm slowly
   trying to bring some order there.  Perhaps a better home would be
   Documentation/kbuild/ ?

Thanks,

jon
diff mbox series

Patch

diff --git a/tools/objtool/Documentation/stack-validation.txt b/Documentation/stack-validation.txt
similarity index 100%
rename from tools/objtool/Documentation/stack-validation.txt
rename to Documentation/stack-validation.txt
diff --git a/Documentation/x86/orc-unwinder.txt b/Documentation/x86/orc-unwinder.txt
index cd4b29b..3aeff80 100644
--- a/Documentation/x86/orc-unwinder.txt
+++ b/Documentation/x86/orc-unwinder.txt
@@ -137,7 +137,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
+Documentation/stack-validation.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