public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Josh Triplett <josh@joshtriplett.org>
To: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Linus Torvalds <torvalds@linux-foundation.org>,
	Rob Landley <rob@landley.net>, Tao Ma <boyu.mt@taobao.com>,
	Andrew Morton <akpm@linux-foundation.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	"H. Peter Anvin" <hpa@zytor.com>
Subject: [PATCH] Documentation/ABI: Document the non-ABI status of Kconfig and symbols
Date: Thu, 24 Oct 2013 09:41:04 +0100	[thread overview]
Message-ID: <20131024084104.GA2861@leaf> (raw)

Discussion at Kernel Summit made it clear that the presence or absence
of specific Kconfig symbols are not considered ABI, and that no
userspace (or bootloader, etc) should rely on them.

In addition, kernel-internal symbols are well established as non-ABI,
per Documentation/stable_api_nonsense.txt.

Document both of these in Documentation/ABI/README, in a new section for
notable bits of non-ABI.

Signed-off-by: Josh Triplett <josh@joshtriplett.org>
---
 Documentation/ABI/README | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/Documentation/ABI/README b/Documentation/ABI/README
index 1006982..1fafc4b 100644
--- a/Documentation/ABI/README
+++ b/Documentation/ABI/README
@@ -72,3 +72,16 @@ kernel tree without going through the obsolete state first.
 
 It's up to the developer to place their interfaces in the category they
 wish for it to start out in.
+
+
+Notable bits of non-ABI, which should not under any circumstances be considered
+stable:
+
+- Kconfig.  Userspace should not rely on the presence or absence of any
+  particular Kconfig symbol, in /proc/config.gz, in the copy of .config
+  commonly installed to /boot, or in any invocation of the kernel build
+  process.
+
+- Kernel-internal symbols.  Do not rely on the presence, absence, location, or
+  type of any kernel symbol, either in System.map files or the kernel binary
+  itself.  See Documentation/stable_api_nonsense.txt.
-- 
1.8.4.rc3


             reply	other threads:[~2013-10-24  8:41 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-10-24  8:41 Josh Triplett [this message]
2013-10-24  8:44 ` [PATCH] Documentation/ABI: Document the non-ABI status of Kconfig and symbols H. Peter Anvin
2013-10-24  8:57 ` Richard Weinberger
2013-10-24  9:08   ` Josh Triplett
2013-11-10 22:03     ` Rob Landley
2013-10-25 15:06   ` H. Peter Anvin

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=20131024084104.GA2861@leaf \
    --to=josh@joshtriplett.org \
    --cc=akpm@linux-foundation.org \
    --cc=boyu.mt@taobao.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hpa@zytor.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rob@landley.net \
    --cc=torvalds@linux-foundation.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