Mercurial > irccd

annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
11 - The functions `server-cnotice` and `server-cmode` have been removed, use
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
12 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
13 - The option `connect.host` has been renamed to `connect.hostname`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
14 - The option `--host` has been renamed to `--hostname`.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
15
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
16 ### Plugins
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
17
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
18 #### Logger
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
19
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
20 - The keyword `source` has been removed and replaced by `channel`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
21 - The keyword `origin` has been added,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
22 - Formats `cnotice`, `cmode`, `query` have been removed.
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
23
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
24 ### Network API
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
25
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
26 - The requests `server-cnotice` and `server-cmode` have been removed, use
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
27 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
28 - The request `server-mode` command requires a new argument `channel`.
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
29 - The property `host` in request `server-connect` has been renamed to
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
30 `hostname`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
31 - The request `server-info` sends `hostname` property instead of `host`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
32 - The event `onWhois` sends `hostname` property instead of `host`.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
33
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 ### CMake options
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
36 - All options are now starting with `IRCCD_` for better compatibility with
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
37 external projects,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
38 - CMake now use GNUInstallDirs module to specify installation paths, all
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
39 IRCCD\_WITH\_ options have been replaced by CMAKE\_INSTALL\_ equivalents.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 ### Paths
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
43 - The default plugins path has been changed from **share/irccd/plugins** to
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
44 **lib64/irccd**.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
46 ### Javascript API
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
48 #### Events
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
50 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
51 must use `Server.isSelf(target)` to determine a channel/private message,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
52 - The event `onNotice` takes a new `channel` argument,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
53 - The event `onMode` takes new `channel`, `limit`, `user`, `mask` arguments,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
54 - The object information in `onWhois` event now has `hostname` property instead
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
55 of `host`.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
57 #### Module Server
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
58
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
59 - The methods `Server.cmode` and `Server.cnotice` have been removed, use
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
60 `Server.mode` and `Server.notice` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
61 - The method `Server.mode` requires a new argument `channel`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
62 - The object returned in the method `Server.info` now has a `hostname` property
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
63 instead of `host`.
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
64
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
65 #### Module ElapsedTimer
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
66
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
67 - The method ElapsedTimer.reset has been removed, just use `start` instead
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
68 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
69
16b9ebfd3f08 Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents: 489
diff changeset
70 #### Module Directory
16b9ebfd3f08 Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents: 489
diff changeset
71
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
72 - 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
73
700
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
74 #### Module Plugin
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
75
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
76 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
77
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
78 - **cachePath** renamed to **paths.cache**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
79 - **configPath** renamed to **paths.config**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
80 - **dataPath** renamed to **paths.data**.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
81
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
82 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
83 `[paths]` and `[paths.<name>]` sections.
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
84
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
85 #### Module Server
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
86
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
87 - The property `host` in the function `Irccd.Server` has been renamed to
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
88 `hostname`.
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
89
700
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
90 #### Module System
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
91
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
92 - The function `Irccd.System.name` has now well defined return value.
733
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
93
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
94 ### Irccd
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
95
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
96 #### Configuration
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
97
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
98 - The option `reconnect-tries` has been removed from `[server]` section, use
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
99 `auto-reconnect` boolean option instead.
bd12709b1975 Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents: 709
diff changeset
100 - The option `reconnect-timeout` has been renamed to `auto-reconnect-delay`.
779
317c66a131be Irccd: merge [identity] with [server], closes #905 @2h
David Demelier <markand@malikania.fr>
parents: 733
diff changeset
101 - The section `[identity]` has been removed, instead move those values inside
317c66a131be Irccd: merge [identity] with [server], closes #905 @2h
David Demelier <markand@malikania.fr>
parents: 733
diff changeset
102 each server in their `[server]` section.