View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0004003 | unreal | documentation | public | 2011-02-05 00:22 | 2011-06-06 18:20 |
| Reporter | nightguardianangel | Assigned To | syzop | ||
| Priority | normal | Severity | minor | Reproducibility | have not tried |
| Status | closed | Resolution | no change required | ||
| Product Version | 3.2.8 | ||||
| Summary | 0004003: Online documentation does not match stable unrealircd (3.2.8.1) | ||||
| Description | On Documentation is states set::level-on-join <none|voice|halfop|op|protect|owner>; The mode that a user will get when he's the first to join a channel. The default is 'op' (channel operator). I tried setting it to owner and rehashed the server and it returned this -irc.chatvillage.com- *** Notice -- Loading IRCd configuration .. - -irc.chatvillage.com- *** Notice -- error: unrealircd.conf:44: set::level-on-join: unknown value 'owner', should be one of: none, op - -irc.chatvillage.com- *** Notice -- error: 1 errors encountered - -irc.chatvillage.com- *** Notice -- error: IRCd configuration failed to pass testing | ||||
| 3rd party modules | |||||
|
|
Try looking in the documentation stored in your unrealircd's doc folder, docs/unreal32docs.html . This local copy of the documentation will always pertain to the tarball within which it was shipped. The version posted online at http://unrealircd.org/docs.php is actually ahead of its time -- sometime last year, the CVS version (which applies to 3.2.9 which is yet to be released) was copied over the 3.2.8 version. Since 3.2.9 should come out ``soon'' (but not for a while ;-)), I don't think that there's really much to do unless if syzop wants to revert the online version of the documentation to the version which ships with unrealircd-3.2.8.1... |
|
|
imho I really don't see this as an error/bug since the header of the document is completely accurate: Version: post-3.2.8 (CVS) Last doc update: 2010-05-17 I don't see anything that says that the online version should/must match the current release. The included docs specifically state that up-to-date documentation is available exactly where it is as promised. /imho |
|
|
Actually I think I have an idea to consider for clarity on this. That is note which version/revision features are added. This will allow the online docs to remain current and not create confusion because a new feature was added. Something like: set::level-on-join <none|voice|halfop|op|protect|owner>; Added:3.2.8.1-cvs r4563 (Date:01-01-2011) The mode that a user will get when he's the first to join a channel. The default is 'op' (channel operator). To keep things simple when backporting the current command set, if a command/feature exists in 3.2.8.1 even though it existed back in 3.2.3, just put 3.2.8.1 I might be able to devote some time to updating the docs. Let me consult my schedule and get back. |
|
|
I agree with katsklaw here. As long as the header explicitly states that this is not version XYZ but another version then it's ok. Sometimes the documentation is changed to fixup mistakes or reword things, sometimes it's updated to include new features. I feel that trying to separate the two, by having several branches will not work ok given the limited resources of us and the translators. So, keeping it as-is. EDIT: and I didn't read your latest comment... yeah that would also work, we'll consider it for 3.3... we'll see.. ;). I would actually like to cleanup the documentation to get rid of all the 'AND HEY thiz iz teh new in 3.2.3' which looks silly... |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2011-02-05 00:22 | nightguardianangel | New Issue | |
| 2011-02-05 02:44 | ohnobinki | Note Added: 0016591 | |
| 2011-02-05 02:45 | ohnobinki | Summary | Documentation Error => Online documentation does not match stable unrealircd (3.2.8.1) |
| 2011-02-05 02:45 | ohnobinki | Assigned To | => syzop |
| 2011-02-05 02:45 | ohnobinki | Status | new => assigned |
| 2011-02-05 18:23 | katsklaw | Note Added: 0016592 | |
| 2011-03-04 04:51 | katsklaw | Note Added: 0016607 | |
| 2011-03-04 04:57 | katsklaw | Note Edited: 0016607 | |
| 2011-06-06 18:20 | syzop | Note Added: 0016665 | |
| 2011-06-06 18:20 | syzop | Status | assigned => closed |
| 2011-06-06 18:20 | syzop | Resolution | open => no change required |
| 2011-06-06 18:22 | syzop | Note Edited: 0016665 |
