Update data
[oweals/hwids.git] / README.md
index ebdc19e71846a977aee8b13d27618663adc3d768..902869c0c648dc475e849438b5f0b186b56116ed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,7 +2,9 @@ Combined hardware identification databases
 ==========================================
 
 This repository contain a specially re-packaged copy of the pci.ids
-and usb.ids files, as well as a copy of IEEE's oui.txt file
+and usb.ids files, as well as a copy of IEEE's databases for the
+Organizationally Unique Identifiers (OUI) and Individual Address Block
+(IAB).
 
 The two IDs databases are maintained by Martin Mares and Michal Vaner
 (pci.ids) and Stephen J. Gowdy (usb.ids) through the help of
@@ -11,8 +13,11 @@ volunteers who can submit them to the two submission web applications:
  * [pci.ids](http://pci-ids.ucw.cz/)
  * [usb.ids](https://usb-ids.gowdy.us/index.html)
 
-The OUI database is an officially maintained index by IEEE, and can be
-accessed at https://standards.ieee.org/develop/regauth/oui/public.html .
+The OUI and IAB databases are two officially maintained indexes by
+IEEE, and can be accessed at:
+
+ * [OUI](http://standards.ieee.org/develop/regauth/oui/public.html)
+ * [IAB](http://standards.ieee.org/develop/regauth/iab/public.html)
 
 The reason to repackage the files together is to make it simpler for
 applications to require them, without having to bring in either
@@ -26,6 +31,28 @@ there are new files available. You can download the tags in form of
 tarballs directly from [the GitHub
 repository](https://github.com/gentoo/hwids).
 
+Bug Reports
+-----------
+
+Errors in the databases (e.g. pci.ids is missing a device, or has the wrong
+info for a device) should be reported to the respective upstream projects.
+We don't maintain changes to these databases for obvious reasons.
+
+If you wish to report a bug about how things are packaged, or make a request
+for updated data, please use the normal Gentoo bug reporting site:
+https://bugs.gentoo.org/
+
+udev
+----
+
+Since version 196 and later, `udev` does not consume the hwid files
+directly. Instead, it only access a specific binary representation,
+which is further generated starting from intermediate representations.
+
+The Makefile will accept a `UDEV=yes` parameter to build and install
+these representations. Furthermore upon install, the binary
+representation will also be generated.
+
 License
 -------
 
@@ -35,28 +62,29 @@ either the GNU General Public License, version 2 or later (which
 you'll find in the archive, in the file named gpl-2.0.txt), or the
 3-clause BSD license that follows:
 
-> Redistribution and use in source and binary forms, with or without
-> modification, are permitted provided that the following conditions are met:
->     * Redistributions of source code must retain the above copyright
->       notice, this list of conditions and the following disclaimer.
->     * Redistributions in binary form must reproduce the above copyright
->       notice, this list of conditions and the following disclaimer in the
->       documentation and/or other materials provided with the distribution.
->     * Neither the name of the <organization> nor the
->       names of its contributors may be used to endorse or promote products
->       derived from this software without specific prior written permission.
->
-> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-> ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-> WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-> DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
-> DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-> (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-> LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-> ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-> (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The OUI database is not officially licensed by IEEE, but should be
-possible to consider it as freely distributable, as a collection of
-facts.
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+        * Redistributions of source code must retain the above copyright
+          notice, this list of conditions and the following disclaimer.
+        * Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+        * Neither the name of the <organization> nor the
+          names of its contributors may be used to endorse or promote products
+          derived from this software without specific prior written permission.
+   
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The IEEE datafiles for OUI and IAB assignments are provided by the
+IEEE without an explicit license, but are considered in all effect as
+public domain, as they are simple representation of factual
+information, which would then fail the threshold of originality test.