Mercurial > irccd

comparison MIGRATING.md @ 785:7145a3df4cb7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: rename host to hostname, closes #941 @2h
author David Demelier <markand@malikania.fr>
date Wed, 07 Nov 2018 12:55:00 +0100
parents 560b62f6b0a7
children 3c090c1ff4f0
comparison
equal deleted inserted replaced
783:d0bd19183743 785:7145a3df4cb7
6 Migrating from 2.x to 3.x 6 Migrating from 2.x to 3.x
7 ------------------------- 7 -------------------------
8 8
9 ### Irccdctl 9 ### Irccdctl
10 10
11 - The functions `server-cnotice` and `server-cmode` have been removed, use 11 - The functions `server-cnotice` and `server-cmode` have been removed, use
12 `server-notice` and `server-mode` instead, 12 `server-notice` and `server-mode` instead,
13 - The option `connect.host` has been renamed to `connect.hostname` (#941). 13 - The option `connect.host` has been renamed to `connect.hostname`,
14 - The option `--host` has been renamed to `--hostname`.
14 15
15 ### Plugins 16 ### Plugins
16 17
17 #### Logger 18 #### Logger
18 19
19 - The keyword `source` has been removed and replaced by `channel`, 20 - The keyword `source` has been removed and replaced by `channel`,
20 - The keyword `origin` has been added, 21 - The keyword `origin` has been added,
21 - Formats `cnotice`, `cmode`, `query` have been removed. 22 - Formats `cnotice`, `cmode`, `query` have been removed.
22 23
23 ### Network API 24 ### Network API
24 25
25 - The requests `server-cnotice` and `server-cmode` have been removed, use 26 - The requests `server-cnotice` and `server-cmode` have been removed, use
26 `server-notice` and `server-mode` instead, 27 `server-notice` and `server-mode` instead,
27 - The request `server-mode` command requires a new argument `channel`. 28 - The request `server-mode` command requires a new argument `channel`.
29 - The property `host` in request `server-connect` has been renamed to
30 `hostname`,
31 - The request `server-info` sends `hostname` property instead of `host`,
32 - The event `onWhois` sends `hostname` property instead of `host`.
28 33
29 ### CMake options 34 ### CMake options
30 35
31 - All options are now starting with `IRCCD_` for better compatibility with 36 - All options are now starting with `IRCCD_` for better compatibility with
32 external projects, 37 external projects,
33 - CMake now use GNUInstallDirs module to specify installation paths, all 38 - CMake now use GNUInstallDirs module to specify installation paths, all
34 IRCCD_WITH_ options have been replaced by CMAKE_INSTALL_ equivalents. 39 IRCCD\_WITH\_ options have been replaced by CMAKE\_INSTALL\_ equivalents.
35 40
36 ### Paths 41 ### Paths
37 42
38 - The default plugins path has been changed from **share/irccd/plugins** to 43 - The default plugins path has been changed from **share/irccd/plugins** to
39 **lib64/irccd**. 44 **lib64/irccd**.
40 45
41 ### Javascript API 46 ### Javascript API
42 47
43 #### Events 48 #### Events
44 49
45 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins 50 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins
46 must use `Server.isSelf(target)` to determine a channel/private message, 51 must use `Server.isSelf(target)` to determine a channel/private message,
47 - The event `onNotice` takes a new `channel` argument, 52 - The event `onNotice` takes a new `channel` argument,
48 - The event `onMode` takes new `channel`, `limit`, `user`, `mask` arguments. 53 - The event `onMode` takes new `channel`, `limit`, `user`, `mask` arguments,
54 - The object information in `onWhois` event now has `hostname` property instead
55 of `host`.
49 56
50 #### Module Server 57 #### Module Server
51 58
52 - The methods `Server.cmode` and `Server.cnotice` have been removed, use 59 - The methods `Server.cmode` and `Server.cnotice` have been removed, use
53 `Server.mode` and `Server.notice` instead, 60 `Server.mode` and `Server.notice` instead,
54 - The method `Server.mode` requires a new argument `channel`. 61 - The method `Server.mode` requires a new argument `channel`,
62 - The object returned in the method `Server.info` now has a `hostname` property
63 instead of `host`.
55 64
56 #### Module ElapsedTimer 65 #### Module ElapsedTimer
57 66
58 - The method ElapsedTimer.reset has been removed, just use `start` instead 67 - The method ElapsedTimer.reset has been removed, just use `start` instead
59 when you want to accumulate time. 68 when you want to accumulate time.
60 69
61 #### Module Directory 70 #### Module Directory
62 71
63 - The property `Directory.count` has been removed. 72 - The property `Directory.count` has been removed.
64 73
65 #### Module Plugin 74 #### Module Plugin
66 75
67 The following properties in `Irccd.Plugin` has been renamed: 76 The following properties in `Irccd.Plugin` has been renamed:
68 77
69 - **cachePath** renamed to **paths.cache**, 78 - **cachePath** renamed to **paths.cache**,
70 - **configPath** renamed to **paths.config**, 79 - **configPath** renamed to **paths.config**,
71 - **dataPath renamed** to **paths.data**. 80 - **dataPath** renamed to **paths.data**.
72 81
73 Note: these paths are no more automatically detected and set with the new 82 Note: these paths are no more automatically detected and set with the new
74 `[paths]` and `[paths.<name>]` sections. 83 `[paths]` and `[paths.<name>]` sections.
75 84
85 #### Module Server
86
87 - The property `host` in the function `Irccd.Server` has been renamed to
88 `hostname`.
89
76 #### Module System 90 #### Module System
77 91
78 - The function `Irccd.System.name` has now well defined return value. 92 - The function `Irccd.System.name` has now well defined return value.
79 93
80 ### Irccd 94 ### Irccd
81 95
82 #### Configuration 96 #### Configuration
83 97