</ul>
<h2>Editing database</h2>
<ul class='navigation'>
- <li><a href='$HELP_URL$newitem'>Submitting new item</a>
+ <li><a href='$HELP_URL$newitem'>Submitting a new item</a>
<li><a href='$HELP_URL$newhistory'>Discussion</a>
<li><a href='$HELP_URL$mailsubmit'>Mail submit</a>
</ul>
Mail submit
<p>
-PCI IDs can be submited and edited using email.
-There is a robot at address <a href='mailto:pci-ids@ucw.cz'>pci-ids@ucw.cz</a>, which accepts patches sent to it.
-Please use unified diffs (<tt>diff -u</tt>) against the current <a href='/static/pci.ids'>pci.ids</a> file (preferably the one just downloaded from this page, but the robot tries hard to recognize older versions as well).
-Avoid base64 encoding and mail agents converting tabs to spaces, breaking lines and so on.
+PCI ID's can be also submitted and edited using email.
<p>
-If you do not have an <a href='$HELP_URL$account'>account</a> yet, one is created for your email address.
-You will get subscribed to notifications about all the items you changed (if you like to tweak the notifications, look at their <a href='$HELP_URL$notifications'>documentation</a>.
+There is a robot listening at <a href='mailto:pci-ids@ucw.cz'>pci-ids@ucw.cz</a>, which has been
+set up to accept patches received by email.
<p>
-Please note, the robot understands only PCI IDs. Other types of IDs must be entered by the web interface.
+Please use unified diffs (<tt>diff -u</tt>) against the current <a href='/v2.2/pci.ids'>pci.ids</a> file (preferably the one just downloaded from this page, but the robot tries hard to recognize older versions as well). Please include the patch in the body of the email (to avoid base64
+encoding which is currently not understood by the robot) and avoid mail agents which convert
+tabs to spaces or wrap long lines. The classical <tt>mail</tt> utility is a safe choice.
+<p>
+If you do not have an <a href='$HELP_URL$account'>account</a> yet, one will be created for you
+automatically. You will be also sent notifications when anybody modifies the items you have
+changed (of course you can tweak the notifications, look at their <a href='$HELP_URL$notifications'>documentation</a>).
+<p>
+Please note that the robot currently understands only PCI ID's. Other types of ID's (classes etc.)
+must be entered via the web interface.
Discussion
<p>
-If you think some information here is wrong, you know better or want to say something about some item, you can enter discussion.
+If you think that some information in the list is wrong, you know better or you want to say something about some item,
+you can enter a discussion comment.
Browse to the item and click the <a href='$AC_URL$newhistory'>discuss</a> link.
<p>
-If you do not want to alter current name or note, provide only text.
-If you want to change name, provide that one too (in that case, you do not have to provide text, but it is recommended to say why you think the new version is better).
-Changing note alone is not possible, you can change it with name only.
-If you change just note, enter the same name as before.
+If you do not want to change the name nor the note, enter only the text of the
+discussion item.
+If you want to change the name, enter the new version and attach a comment
+explaining the reason for the change.
+If you want to change only the note, please enter it with the same name as before.
<p>
You can request item deletion here, too.
-<h2>Approval</h2>
-<p>
-All submissions are checked by an admin for errors.
-Please try to provide valid information.
-You should check specific help for corresponding ID type:
-<ul class='navigation'>
- <li><a href='$HELP_URL$pci'>PCI devices</a>
- <li><a href='$HELP_URL$pci_class'>PCI device classes</a>
-</ul>
+<p>
+Please see the help on <a href='$HELP_URL$newitem'>creating new items</a> for
+hints about what to submit and what to avoid.
<h2>Notification subscription</h2>
<p>
If the subscribe checkbox is checked, a notification on the new item will be created for you.
For more information about notifications look at <a href='$HELP_URL$notifications'>their documentation</a>.
<p>
-The checkbox is present only unless you have a notification covering this item already.
+The checkbox is present only if you do not have a notification covering this item yet.
<h2>See also</h2>
<p>
-You can create <a href='$HELP_URL$newitem'>new items</a>.
+You can
also create <a href='$HELP_URL$newitem'>new items</a>.
<p>
If you want to know about changes in some item, set up <a href='$HELP_URL$notifications'>a notification</a>.
Add a new item
<p>
-If you know about an ID not present here, you can submit it.
-Browse to the item which should contain it and click <a href='$AC_URL$newitem'>add item</a> link.
-<p>
-You need to fill in the ID and its name.
-The ID is just the last part (without parent part, for example if you have PCI device <tt>1234:5678</tt> and the vendor <tt>1234</tt> already exists, you enter only <tt>5678</tt>).
+If you know about an ID which is not listed in the database, you will be welcome
+to submit it.
+Just browse to the parent item and click on the <a href='$AC_URL$newitem'>add item</a> link.
+If you want to change an existing entry, just <a href='$HELP_URL$newdiscuss'>post a discussion
+item</a> instead.
+<p>
+To create a new entry, you need to fill in the ID and its name.
+The ID is just the last part (without the parent part; for example if you have PCI device
+<tt>1234:5678</tt> and the vendor <tt>1234</tt> already exists, you enter only <tt>5678</tt>).
If you know chip name, it is preferred over marketing name.
<p>
You can add some note to the name, for example, if the ID is not really owned by the company using it.
<h2>Approval</h2>
<p>
-Each item is checked and approved by an admin.
-It is because not all submissions are correct.
+All submissions are checked by the administrators for errors. The admins either approve
+the entry, or ask you to correct it or to provide more details. In cases of blatant
+abuse (spam in comments etc.), they have the power to remove the entry completely.
<p>
-If you want to it to get approved, please check you enter valid information into correct place (eg. not an USB ID into PCI devices, Device into its vendor).
-You should check help specific for each tree:
+Before submitting changes, please consult the
+You should check specific help for corresponding ID type:
<ul class='navigation'>
<li><a href='$HELP_URL$pci'>PCI devices</a>
<li><a href='$HELP_URL$pci_class'>PCI device classes</a>
Notifications
<p>
-If you are interested in any changes in some item, you can set up a notification to get informed.
-Browse to the item and click <a href='$AC_URL$notifications'>notifications</a> link (it is visible only when you are <a href='$HELP_URL$account'>logged in</a>.
-You can set these things:
+If you want to monitor changes of an item, you can set up a notification to get informed
+whenever it changes.
+Browse to the item and click the <a href='$AC_URL$notifications'>notifications</a> link (it is visible only when you are <a href='$HELP_URL$account'>logged in</a>).
+You can set:
<ul>
- <li><strong>Effect range</strong> ‒ which IDs are considered by this notification. If the notification is not recursive, only the current ID is taken into account. Recursive notifications work on the given ID and its whole subtree (sub-items, their sub-items, …).
- <li><strong>Notification level</strong> ‒ how serious even needs to happen to trigger the notification. None means the notification never happens (it does not exist, you can delete it by setting it to it), main comment means whenever admin approves change of a name, sub-item is when someone submits new item with this one as a parent, suggestion is when someone suggests a new name for the item (but is not yet approved) and discussion is whenever someone writes anything.
- All the more common notifications contain the less common (when you check discussion and an admin approves a name change, it is triggered too, but not the other way around).
+ <li><strong>Effect range</strong> ‒ which ID's are considered for this notification. If the notification is not recursive, only the current ID is taken into account. Recursive notifications work on the given ID and its whole subtree (sub-items, their sub-items, …).
+ <li><strong>Notification level</strong> ‒ how serious an event needs to happen to trigger the notification. <em>None</em> means that the notification never happens (it ceases to exist, you can delete it by setting it to this level), <em>main comment</em> means whenever an admin approves a change of the name, <em>sub-item</em> is triggered when someone submits a new item with this one as a parent, <em>suggestion</em> is when someone suggests a new name for the item (but it is not yet approved) and <em>discussion</em> means whenever anybody writes anything.
+ All the more general notifications contain the less general ones (when you check discussion and an admin approves a name change, it is triggered too, but not the other way around).
<li><strong>Notification way</strong> ‒ the way the notification gets to you.
</ul>
<h2>See also</h2>
<p>
-This is all your own configuration. You can <a href='$HELP_URL$account'>get an account</a> so you can set it up.
+The notifications are a part of your personal settings. You need to <a href='$HELP_URL$account'>get an account</a> in order to set them up.
<p>
-You can
set up various things (like address, where the notifications are sent) in your <a href='$HELP_URL$profile'>profile</a>.
+You can
configure various things (like the address where the notifications are sent) in your <a href='$HELP_URL$profile'>profile</a>.
User profile
<p>
When you are logged in, you can find a <a href='$AC_URL$profile'>profile</a> link.
-You can set various information about your account.
+You can set various information about your account there:
<ul>
- <li><strong>Email</strong> ‒ this is the address email notifications about changes in database will be sent.
- It is used for resetting password and you can log in using it.
+ <li><strong>Email</strong> ‒ this is the address to which email notifications about changes in the database will be sent.
+ It is also used for logging in or for resetting your password.
<li><strong>Login</strong> ‒ you can log in using this one instead of your email address.
- Furthermore, it is showed with discussion comments you wrote.
+ Furthermore, it is displayed along all discussion comments you wrote.
<li><strong>Xmpp</strong> ‒ you can get notifications using xmpp (aka jabber) as well as email.
- <li><strong>Password</strong> ‒ if you want to set new password, fill in both new password and confirm password boxes.
- <li><strong>Batch times</strong> ‒ if you want to group notifications together, so you receive less messages.
- This is the time in minutes, for how long the system will gather notifications before it sends them by email or xmpp respectively.
+ <li><strong>Password</strong> ‒ if you want to set a new password, fill in both the new password and confirm password boxes.
+ <li><strong>Batch times</strong> ‒ you can ask for having your notifications grouped together, so that you receive less messages.
+ Enter a time in minutes.
</ul>
<h2>Password protected values</h2>
<p>
-Email, login and new password are protected by the old password.
+Email, login and the new password are protected by the old password.
If you want to change any of these, you must provide the old password to unlock them.
<h2>See also</h2>
<p>
-You can get a profile by <a href='$HELP_URL$account'>registering it</a>.
+You can get a profile by <a href='$HELP_URL$account'>registering an account</a>.
<p>
To receive any notifications, you need to <a href='$HELP_URL$notifications'>set them up</a>.
projects / pciids.git / commitdiff