Re: [RFC PATCH v3 6/6] Documentation: livepatch: outline the Elf format of a livepatch module

On Tue, Jan 12, 2016 at 01:09:51PM +0100, Petr Mladek wrote:

Hi Jessica,

first, thanks a lot for writing a documentation. It is really
appreciated!

To be honest, I am not sure if it makes sense to give feedback
at this stage. It seems that there still will be some changes
in the elf format.

On Fri 2016-01-08 14:28:24, Jessica Yu wrote:

quoted

Document the special Elf sections and constants livepatch modules use.

Signed-off-by: Jessica Yu <redacted>
---
 Documentation/livepatch/patch-module-format.txt | 106 ++++++++++++++++++++++++
 1 file changed, 106 insertions(+)
 create mode 100644 Documentation/livepatch/patch-module-format.txt

I would call this symbol-relocation.txt or so. It describes only this
part of the patch format.

quoted

diff --git a/Documentation/livepatch/patch-module-format.txt b/Documentation/livepatch/patch-module-format.txt
new file mode 100644
index 0000000..d825629
--- /dev/null
+++ b/Documentation/livepatch/patch-module-format.txt

@@ -0,0 +1,106 @@
+---------------------------
+Livepatch module Elf format
+---------------------------

I would start with a description what symbols are relocated and why
it needs to be done a special way.

The cover letter has this information, and a lot of other useful
background.  It would be good to add all that background to this
document as an introduction.

-- 
Josh