linux-pci.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Michael S. Tsirkin" <mst@redhat.com>
To: linux-kernel@vger.kernel.org
Cc: Bjorn Helgaas <bhelgaas@google.com>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-pci@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH] pci.txt: clarify vendor ID policy
Date: Mon, 30 Mar 2015 10:32:34 +0200	[thread overview]
Message-ID: <1427704341-14125-1-git-send-email-mst@redhat.com> (raw)

Top of include/linux/pci_ids.h says:
	Do not add new entries to this file unless the definitions
	are shared between multiple drivers.
on the other hand, Documentation/PCI/pci.txt seems to imply that all
vendor IDs should be added in include/linux/pci_ids.h.

Clarify text pci.txt to avoid the apparent contradiction.

Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
---
 Documentation/PCI/pci.txt | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/Documentation/PCI/pci.txt b/Documentation/PCI/pci.txt
index 53da450..47b0e28 100644
--- a/Documentation/PCI/pci.txt
+++ b/Documentation/PCI/pci.txt
@@ -564,12 +564,15 @@ to be handled by platform and generic code, not individual drivers.
 8. Vendor and device identifications
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-One is not required to add new device ids to include/linux/pci_ids.h.
-Please add PCI_VENDOR_ID_xxx for vendors and a hex constant for device ids.
+One is not required to add new device or vendor ids to include/linux/pci_ids.h.
+Please define PCI_VENDOR_ID_xxx for vendor ids and use a hex constant for
+device ids in your driver.
 
-PCI_VENDOR_ID_xxx constants are re-used. The device ids are arbitrary
-hex numbers (vendor controlled) and normally used only in a single
-location, the pci_device_id table.
+Only PCI_VENDOR_ID_xxx constant definitions that are re-used between multiple
+drivers should be added to include/linux/pci_ids.h.
+
+The device ids are arbitrary hex numbers (vendor controlled) and normally used
+only in a single location, the pci_device_id table.
 
 Please DO submit new vendor/device ids to pciids.sourceforge.net project.
 
-- 
MST

             reply	other threads:[~2015-03-30  8:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-30  8:32 Michael S. Tsirkin [this message]
2015-04-09 19:12 ` [PATCH] pci.txt: clarify vendor ID policy Bjorn Helgaas

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=1427704341-14125-1-git-send-email-mst@redhat.com \
    --to=mst@redhat.com \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@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
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;
as well as URLs for NNTP newsgroup(s).