Mercurial > irccd

comparison MIGRATING.md @ 574:18e80ec38ac7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
573:067240931226 574:18e80ec38ac7
4 This document is a small guide to help you migrating to a next major version. 4 This document is a small guide to help you migrating to a next major version.
5 5
6 Migrating from 2.x to 3.x 6 Migrating from 2.x to 3.x
7 ------------------------- 7 -------------------------
8 8
9 ### Irccdctl
10
11 - The functions `server-cnotice` and `server-cmode` have been removed, use
12 `server-notice` and `server-mode` instead.
13
14 ### Network API
15
16 - The requests `server-cnotice` and `server-cmode` have been removed, use
17 `server-notice` and `server-mode` instead,
18 - The request `server-mode` command requires a new argument `channel`.
19
9 ### CMake options 20 ### CMake options
10 21
11 - WITH_CONFDIR has been renamed to WITH_SYSCONFDIR. 22 - `WITH_CONFDIR` has been renamed to `WITH_SYSCONFDIR`.
12 23
13 ### Paths 24 ### Paths
14 25
15 - The default plugins path has been changed from **share/irccd/plugins** to 26 - The default plugins path has been changed from **share/irccd/plugins** to
16 **libexec/irccd/plugins**. 27 **libexec/irccd/plugins**.
17 28
18 ### Plugin configuration 29 ### Javascript API
19 30
20 The following properties in `Irccd.Plugin` has been renamed: 31 #### Events
21 32
22 - cachePath renamed to paths.cache, 33 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins
23 - configPath renamed to paths.config, 34 must use `Server.isSelf(target)` to determine a channel/private message.
24 - dataPath renamed to paths.data.
25 35
26 Note: these paths are no more automatically detected and set with the new 36 #### Module Server
27 `[paths]` and `[paths.<name>]` sections.
28 37
29 ### Javascript API 38 - The methods `Server.cmode` and `Server.cnotice` have been removed, use
39 `Server.mode` and `Server.notice` instead,
40 - The method `Server.mode` requires a new argument `channel`.
30 41
31 #### Module ElapsedTimer 42 #### Module ElapsedTimer
32 43
33 - The method ElapsedTimer.reset has been removed, just use `start` instead 44 - The method ElapsedTimer.reset has been removed, just use `start` instead
34 when you want to accumulate time. 45 when you want to accumulate time.
35 46
36 #### Module Directory 47 #### Module Directory
37 48
38 - The property `Directory.count` has been removed. 49 - The property `Directory.count` has been removed.
50
51 ### Module Plugin
52
53 The following properties in `Irccd.Plugin` has been renamed:
54
55 - **cachePath** renamed to **paths.cache**,
56 - **configPath** renamed to **paths.config**,
57 - **dataPath renamed** to **paths.data**.
58
59 Note: these paths are no more automatically detected and set with the new
60 `[paths]` and `[paths.<name>]` sections.
61