From: Joe Lawrence <joe.lawrence@redhat.com> To: live-patching@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 2/2] samples/livepatch: Add README.rst disclaimer Date: Tue, 21 Jul 2020 12:14:07 -0400 Message-ID: <20200721161407.26806-3-joe.lawrence@redhat.com> (raw) In-Reply-To: <20200721161407.26806-1-joe.lawrence@redhat.com> The livepatch samples aren't very careful with respect to compiler IPA-optimization of target kernel functions. Add a quick disclaimer and pointer to the compiler-considerations.rst file to warn readers. Suggested-by: Josh Poimboeuf <jpoimboe@redhat.com> Signed-off-by: Joe Lawrence <joe.lawrence@redhat.com> --- samples/livepatch/README.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 samples/livepatch/README.rst diff --git a/samples/livepatch/README.rst b/samples/livepatch/README.rst new file mode 100644 index 000000000000..2f8ef945f2ac --- /dev/null +++ b/samples/livepatch/README.rst @@ -0,0 +1,15 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +========== +Disclaimer +========== + +The livepatch sample programs were written with idealized compiler +output in mind. That is to say that they do not consider ways in which +optimization may transform target kernel functions. + +The samples present only a simple API demonstration and should not be +considered completely safe. + +See the Documentation/livepatching/compiler-considerations.rst file for +more details on compiler optimizations and how they affect livepatching. -- 2.21.3
next prev parent reply index Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-07-21 16:14 [PATCH 0/2] livepatch: Add compiler optimization disclaimer/docs Joe Lawrence 2020-07-21 16:14 ` [PATCH 1/2] docs/livepatch: Add new compiler considerations doc Joe Lawrence 2020-07-21 23:04 ` Josh Poimboeuf 2020-07-22 17:03 ` Joe Lawrence 2020-07-22 20:51 ` Josh Poimboeuf 2020-08-06 12:03 ` Petr Mladek 2020-08-10 19:46 ` refactoring livepatch documentation was " Joe Lawrence 2020-09-01 17:12 ` Josh Poimboeuf 2020-09-02 14:00 ` Miroslav Benes 2020-09-02 13:45 ` Miroslav Benes 2020-07-21 16:14 ` Joe Lawrence [this message] 2020-08-06 12:07 ` [PATCH 2/2] samples/livepatch: Add README.rst disclaimer Petr Mladek 2020-09-02 13:46 ` Miroslav Benes
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=20200721161407.26806-3-joe.lawrence@redhat.com \ --to=joe.lawrence@redhat.com \ --cc=linux-kernel@vger.kernel.org \ --cc=live-patching@vger.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
Live-Patching Archive on lore.kernel.org Archives are clonable: git clone --mirror https://lore.kernel.org/live-patching/0 live-patching/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 live-patching live-patching/ https://lore.kernel.org/live-patching \ live-patching@vger.kernel.org public-inbox-index live-patching Example config snippet for mirrors Newsgroup available over NNTP: nntp://nntp.lore.kernel.org/org.kernel.vger.live-patching AGPL code for this site: git clone https://public-inbox.org/public-inbox.git