Mercurial > irccd
annotate MIGRATING.md @ 574:18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
Do not make separate events on messages, notices and modes. This was
currently added because the original libircclient made these
distinctions between the both. In the IRC specification, the channel
represents both a nickname and a real channel.
Delete:
- onChannelMode,
- onChannelNotice,
- onQuery,
- onQueryCommand.
Add:
- Server.isSelf(target).
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 29 Nov 2017 14:44:36 +0100 |
parents | 16b9ebfd3f08 |
children | 3d0dbc0bee7d |
rev | line source |
---|---|
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 IRC Client Daemon MIGRATING |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 =========================== |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 This document is a small guide to help you migrating to a next major version. |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 Migrating from 2.x to 3.x |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 ------------------------- |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
9 ### Irccdctl |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
10 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
11 - The functions `server-cnotice` and `server-cmode` have been removed, use |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
12 `server-notice` and `server-mode` instead. |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
13 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
14 ### Network API |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
15 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
16 - The requests `server-cnotice` and `server-cmode` have been removed, use |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
17 `server-notice` and `server-mode` instead, |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
18 - The request `server-mode` command requires a new argument `channel`. |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
19 |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 ### CMake options |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
22 - `WITH_CONFDIR` has been renamed to `WITH_SYSCONFDIR`. |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 ### Paths |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 - The default plugins path has been changed from **share/irccd/plugins** to |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 **libexec/irccd/plugins**. |
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
29 ### Javascript API |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
31 #### Events |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
33 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
34 must use `Server.isSelf(target)` to determine a channel/private message. |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
36 #### Module Server |
489
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
37 |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
38 - The methods `Server.cmode` and `Server.cnotice` have been removed, use |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
39 `Server.mode` and `Server.notice` instead, |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
40 - The method `Server.mode` requires a new argument `channel`. |
489
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
41 |
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
42 #### Module ElapsedTimer |
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
43 |
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
44 - The method ElapsedTimer.reset has been removed, just use `start` instead |
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
45 when you want to accumulate time. |
514
16b9ebfd3f08
Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents:
489
diff
changeset
|
46 |
16b9ebfd3f08
Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents:
489
diff
changeset
|
47 #### Module Directory |
16b9ebfd3f08
Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents:
489
diff
changeset
|
48 |
16b9ebfd3f08
Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents:
489
diff
changeset
|
49 - The property `Directory.count` has been removed. |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
50 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
51 ### Module Plugin |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
52 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
53 The following properties in `Irccd.Plugin` has been renamed: |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
54 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
55 - **cachePath** renamed to **paths.cache**, |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
56 - **configPath** renamed to **paths.config**, |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
57 - **dataPath renamed** to **paths.data**. |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
58 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
59 Note: these paths are no more automatically detected and set with the new |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
60 `[paths]` and `[paths.<name>]` sections. |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
61 |