From 6d5de012bb0bdab90af528c78bcd710a46954c8f Mon Sep 17 00:00:00 2001 From: Martin Mares Date: Sat, 4 Oct 2008 21:18:23 +0200 Subject: [PATCH] More revisions of the help. --- help/index | 2 +- help/mailsubmit | 20 +++++++++++++------- help/newhistory | 28 ++++++++++++---------------- help/newitem | 23 ++++++++++++++--------- help/notifications | 17 +++++++++-------- help/profile | 18 +++++++++--------- 6 files changed, 58 insertions(+), 50 deletions(-) diff --git a/help/index b/help/index index 79fe89f..075c635 100644 --- a/help/index +++ b/help/index @@ -12,7 +12,7 @@ Help index

Editing database

diff --git a/help/mailsubmit b/help/mailsubmit index 26033d8..d12d072 100644 --- a/help/mailsubmit +++ b/help/mailsubmit @@ -1,11 +1,17 @@ Mail submit

-PCI IDs can be submited and edited using email. -There is a robot at address pci-ids@ucw.cz, which accepts patches sent to it. -Please use unified diffs (diff -u) against the current pci.ids 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.

-If you do not have an account 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 documentation. +There is a robot listening at pci-ids@ucw.cz, which has been +set up to accept patches received by email.

-Please note, the robot understands only PCI IDs. Other types of IDs must be entered by the web interface. +Please use unified diffs (diff -u) against the current pci.ids 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 mail utility is a safe choice. +

+If you do not have an account 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 documentation). +

+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. diff --git a/help/newhistory b/help/newhistory index 654418d..0e3cbe8 100644 --- a/help/newhistory +++ b/help/newhistory @@ -1,34 +1,30 @@ Discussion

-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 discuss link.

-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.

You can request item deletion here, too. -

Approval

-

-All submissions are checked by an admin for errors. -Please try to provide valid information. -You should check specific help for corresponding ID type: -

+

+Please see the help on creating new items for +hints about what to submit and what to avoid.

Notification subscription

If the subscribe checkbox is checked, a notification on the new item will be created for you. For more information about notifications look at their documentation.

-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.

See also

-You can create new items. +You can also create new items.

If you want to know about changes in some item, set up a notification. diff --git a/help/newitem b/help/newitem index e073b8f..5024b92 100644 --- a/help/newitem +++ b/help/newitem @@ -1,10 +1,14 @@ Add a new item

-If you know about an ID not present here, you can submit it. -Browse to the item which should contain it and click add item link. -

-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 1234:5678 and the vendor 1234 already exists, you enter only 5678). +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 add item link. +If you want to change an existing entry, just post a discussion +item instead. +

+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 +1234:5678 and the vendor 1234 already exists, you enter only 5678). If you know chip name, it is preferred over marketing name.

You can add some note to the name, for example, if the ID is not really owned by the company using it. @@ -18,11 +22,12 @@ After you submit it, it will wait approval of an admin.

Approval

-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.

-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: