public inbox for linux-pci@vger.kernel.org
 help / color / mirror / Atom feed
From: "Luis R. Rodriguez" <mcgrof@do-not-panic.com>
To: corbet@lwn.net, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, mingo@elte.hu,
	gnomes@lxorguk.ukuu.org.uk, gregkh@linuxfoundation.org,
	jkosina@suse.cz, bhelgaas@google.com, linux-pci@vger.kernel.org,
	xen-devel@lists.xenproject.org, bp@suse.de,
	"Luis R. Rodriguez" <mcgrof@suse.com>
Subject: [PATCH] Documentation: extend use case for EXPORT_SYMBOL_GPL()
Date: Thu, 28 May 2015 11:56:01 -0700	[thread overview]
Message-ID: <1432839361-10308-1-git-send-email-mcgrof@do-not-panic.com> (raw)

From: "Luis R. Rodriguez" <mcgrof@suse.com>

Current documentation over use case for EXPORT_SYMBOL_GPL()
only acknowledges functions which are "an internal implementation
issue, and not really an interface". In practice these days
though we have some maintainers taking on preferences to require
all new functionality go in with EXPORT_SYMBOL_GPL().

A maintainer asking developers to use EXPORT_SYMBOL_GPL()
for new functionality tends to be a well accepted and understood
position that maintainers can take and typically requires the
maintainers educating contributing developers on their own
positions and requirements.

Developers who submit code to maintainers not familiar with
these preferences as optional for new functionality need explicit
guidence though as existing documentation does not acknowledge
this as a valid possibility. Without this being documented some
maintainers are reluctant to accept new functionality with
EXPORT_SYMBOL_GPL().

This extends the use case documentation for EXPORT_SYMBOL_GPL()
to acknowledge acceptance for new functionality.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Luis R. Rodriguez <mcgrof@suse.com>
---
 Documentation/DocBook/kernel-hacking.tmpl | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/DocBook/kernel-hacking.tmpl b/Documentation/DocBook/kernel-hacking.tmpl
index e84f094..19e0c88 100644
--- a/Documentation/DocBook/kernel-hacking.tmpl
+++ b/Documentation/DocBook/kernel-hacking.tmpl
@@ -954,6 +954,8 @@ printk(KERN_INFO "my ip: %pI4\n", &amp;ipaddress);
     <function>MODULE_LICENSE()</function> that specifies a GPL
     compatible license.  It implies that the function is considered
     an internal implementation issue, and not really an interface.
+    Some maintainers and developers may however have a preference to
+    require EXPORT_SYMBOL_GPL() when adding any new APIs or functionality.
    </para>
   </sect1>
  </chapter>
-- 
2.3.2.209.gd67f9d5.dirty


             reply	other threads:[~2015-05-28 18:58 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-28 18:56 Luis R. Rodriguez [this message]
2015-05-28 19:09 ` [PATCH] Documentation: extend use case for EXPORT_SYMBOL_GPL() Jonathan Corbet
2015-05-28 19:18   ` Luis R. Rodriguez
2015-05-28 19:35     ` Jonathan Corbet
2015-05-28 20:07 ` Al Viro
2015-05-28 21:17   ` Luis R. Rodriguez
2015-05-28 21:56     ` Al Viro
2015-05-28 23:10       ` Luis R. Rodriguez
2015-05-29  5:00         ` Christoph Hellwig
2015-05-29 17:40           ` Luis R. Rodriguez
2015-05-29  1:30 ` Rob Landley

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=1432839361-10308-1-git-send-email-mcgrof@do-not-panic.com \
    --to=mcgrof@do-not-panic.com \
    --cc=bhelgaas@google.com \
    --cc=bp@suse.de \
    --cc=corbet@lwn.net \
    --cc=gnomes@lxorguk.ukuu.org.uk \
    --cc=gregkh@linuxfoundation.org \
    --cc=jkosina@suse.cz \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=mcgrof@suse.com \
    --cc=mingo@elte.hu \
    --cc=xen-devel@lists.xenproject.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