]> mj.ucw.cz Git - pciids.git/blob - help/newitem
ids_to_dbdump is still needed by the mailbot
[pciids.git] / help / newitem
1 Adding new items
2 <h2>Adding new items</h2>
3 <p>
4 If you know about an ID which is not listed in the database, you are welcome
5 to submit a new entry.
6 <p>
7 Please note that we are not assigning new IDs, only keeping records on their existence and meaning.
8 (Vendor IDs are assigned by the <a href='https://pcisig.com/'>PCI SIG</a> to their members,
9 device IDs by the respective vendors.)
10 <p>
11 To add a new entry, browse to its parent entry, click on the <a href='$AC_URL$newitem'>add item</a> link
12 and enter the last part of the new ID (without the parent ID) together with its name.
13 For example, when you want to submit the PCI device <tt>1234:5678</tt> (vendor ID <tt>1234</tt>,
14 device ID <tt>5678</tt>) and the vendor <tt>1234</tt> already exists, go to the page of
15 that vendor and enter a new item with ID <tt>5678</tt> there.
16 <p>
17 If you want to change an existing entry, just <a href='$HELP_URL$newhistory'>post a discussion
18 item</a> instead.
19 <p>
20 You can also add a note to the name. The notes are distributed together with the ID's,
21 so they should be used only in important cases (for example to draw attention to the fact
22 that the ID was used by a different company due to a mistake).
23 <p>
24 If you want to comment on anything, feel free to post a discussion comment. (Unlike
25 the note, it is only kept for other people editing the lists, not distributed to
26 users.)
27 <p>
28 After you submit the change, it will wait for approval by an admin.
29
30 <h2>Rules</h2>
31 <p>
32 <em>There is a couple of simple rules you should obey:</em>
33 <ul>
34         <li>Avoid generic names like "unknown network card", they are not
35         likely to help anybody.
36         <li>Prefer chip names over marketing names. If you know both,
37         please include the marketing name in square brackets
38         (e.g., "<tt>3c595 100BaseTX [Vortex]</tt>").
39         <li>Do not repeat the name of the vendor in the name of the device.
40         <li>Look at the names of similar devices and follow the same form.
41         <li>Verify the kind of the entry: do not submit subsystems as devices,
42         do not submit USB ID's to the PCI lists :-)
43 </ul>
44 <p>If you are not familar with the syntax of the ID's, please check the description:
45 <ul class='navigation'>
46         <li><a href='$HELP_URL$pci'>PCI devices</a>
47         <li><a href='$HELP_URL$pci_class'>PCI device classes</a>
48 </ul>
49
50 <h2>Approval</h2>
51 <p>
52 All submissions are checked by the administrators for errors. The admins either approve
53 the entry, or ask you to correct it or to provide more details. In cases of blatant
54 abuse (spam in comments etc.), they have the power to remove the entry completely.
55 <p>
56
57 <h2>Notification subscription</h2>
58 <p>
59 If the subscribe checkbox is checked, a notification on the new item will be created for you.
60 For more information about notifications look at <a href='$HELP_URL$notifications'>their documentation</a>.
61
62 <h2>See also</h2>
63 <p>
64 Once an item is submitted, it is not sealed for ever. You can <a href='$HELP_URL$newhistory'>discuss</a> existing items and suggest new names for them.
65 <p>
66 If you are interested in changes in some item (or in its whole subtree), you can let the system send you <a href='$HELP_URL$notifications'>notifications</a>.