Initial Commit
[temp.git] / site-lisp / cedet-1.0pre4 / ecb-2.32 / RELEASE_NOTES
blobf77a76605e406a9fe6a90e030b8700433e5c570e
1 This file contains some important release-notes for ECB version 2.32
3 General:
4 --------
6 Please read also the sections "Known conflicts and bugs" and "Tips and Tricks"
7 in the online help ('ecb-show-help'). The former one is a small list of known
8 conflicts and for each conflict a proper and easy solution! Please read also
9 carefully the upgrade informations below!
12 Installing ECB first time:
13 --------------------------
15 No special notes beyond the contents of README.
18 Upgrading from any version:
19 ---------------------------
21 The option `ecb-auto-expand-tag-tree-collapse-other' has changed its type. ECB
22 autom. upgrades your old setting to the new option-type.
25 Upgrading from any version < 2.26:
26 ----------------------------------
28 Some regexp-options has been changed to regexp-list-options:
29 `ecb-excluded-directories-regexp' --> `ecb-excluded-directories-regexps'
30 `ecb-source-file-regexps'         --> `ecb-source-file-regexps'
31 `ecb-exclude-parents-regexp'      --> `ecb-exclude-parents-regexps'
33 All these options now accept (and require) a list of regexps instead of
34 exactly one big regexp. ECB autom. upgrades your old settings to the new
35 option-types rsp. also -names (if the option has been renamed).
38 Upgrading from versions < 2.25:
39 -------------------------------
41 `ecb-sort-history-items' has been renamed to `ecb-history-sort-method'. ECB
42 autom. upgrades your old setting to the new option-name and -type.!
45 Upgrading from versions < 2.23:
46 -------------------------------
48 The option `ecb-show-tags' has changed its type. ECB autom. upgrades your old
49 setting to the new option-type.!
52 Upgrading from versions < 2.20:
53 -------------------------------
55 All user-defined extensions written for and added to one of the options
56 `ecb-directories-menu-user-extension', `ecb-sources-menu-user-extension',
57 `ecb-methods-menu-user-extension' or `ecb-history-menu-user-extension' MUST be
58 rewritten and redefined via the new macro `tree-buffer-defpopup-command'!
60 The option `ecb-primary-mouse-jump-destination' has been renamed to
61 `ecb-mouse-click-destination' and has also changed its default value to
62 'last-point.
64 The option `ecb-split-edit-window' has been renamed in
65 `ecb-split-edit-window-after-start'. In addition the value t is not allowed
66 anymore for this option - use 'before-activation instead. In a further
67 addition this option has a new default value 'before-deactivation. See the
68 docstring of this option to get all details.
70 The Option `ecb-other-window-jump-behavior' has been renamed to
71 `ecb-other-window-behavior'.
73 ECB autom. upgrades your old settings to the new option types/names!
75     
76 Upgrading from versions < 2.11:
77 -------------------------------
79 The type of the option `ecb-post-process-semantic-taglist' has been changed.
80 ECB autom. upgrades the old-value of that option to the new type! There is
81 nothing to do for you. 
84 Upgrading from versions < 2.01:
85 -------------------------------
87 The following options have changed their name:
89 - ecb-auto-expand-token-tree           -> ecb-auto-expand-tag-tree
90 - ecb-font-lock-tokens                 -> ecb-font-lock-tags
91 - ecb-token-jump-sets-mark             -> ecb-tag-jump-sets-mark
92 - ecb-token-display-function           -> ecb-tag-display-function
93 - ecb-type-token-display               -> ecb-type-tag-display
94 - ecb-post-process-semantic-tokenlist  -> ecb-post-process-semantic-taglist
95 - ecb-show-only-positioned-tokens      -> ecb-show-only-positioned-tags
96 - ecb-show-tokens                      -> ecb-show-tags
97 - ecb-highlight-token-with-point       -> ecb-highlight-tag-with-point
98 - ecb-highlight-token-with-point-delay -> ecb-highlight-tag-with-point-delay
99 - ecb-token-visit-post-actions         -> ecb-tag-visit-post-actions
100 - ecb-token-header-face                -> ecb-tag-header-face
102 ECB autom. upgrades all old-values of these options to the new options! There
103 is nothing to do for you.
105 The type of the options `ecb-directories-menu-user-extension',
106 `ecb-sources-menu-user-extension', `ecb-methods-menu-user-extension' and
107 `ecb-history-menu-user-extension' has been changed - now sub-menus are
108 allowed. The new default values of these options contains now entries, mostly
109 concerning "version control". ECB autom. upgrades the old-values to the new
110 option-type by appending the new defaults to your old values. So no old
111 personal menu-entries are lost, but cause of the new default maybe you have
112 some entries twice. Feel free to delete via customize what you want from the
113 new settings.
115 The old option `ecb-tree-use-image-icons' has been replaced by
116 `ecb-tree-buffer-style'.
119 Upgrading from versions < 1.96:
120 -------------------------------
122 The options `ecb-mode-line-data' and `ecb-mode-line-prefixes' have changed
123 their type. ECB will autom. upgrade the old values of these options as best as
124 possible to the new types!
126 The option `ecb-layout-switch-to-compilation-window' has been removed. This
127 mimic is now done automatically.
129 The name of the command `ecb-toggle-enlarged-compilation-window' has been
130 changed to `ecb-toggle-compile-window-height' (The old name is still available
131 as alias but is deprecated). The keybinding [C-. /] remains.
133 The command `ecb-eshell-goto-eshell' has been removed. Now just use `eshell'
134 to work with the eshell. The old binding [C-. e] now simply runs `eshell'.
136 The command `ecb-eshell-enlarge' has been removed. Now just use the standard
137 ECB-command `ecb-toggle-compile-window-height' for this.
140 Upgrading from a version < 1.95.1:
141 ----------------------------------
143 If there are byte-compiled(!) user-defined layouts - either created
144 interactively by `ecb-create-new-layout' or programmed with the macro
145 `ecb-layout-define' - then the file where these user-defined layouts are saved
146 (see option `ecb-create-layout-file') must be re-byte-compiled with latest ECB
147 version >= 1.95.1! If the user-defined layouts are not byte-compiled then
148 there is nothing to do.
150 Some default key-bindings have changed; the new bindings are:
152   C-c . g1: `ecb-goto-window-edit1'       (was C-c . 1)
153   C-c . g2: `ecb-goto-window-edit2'       (was C-c . 2)
154   C-c . gd: `ecb-goto-window-directories' (was C-c . d)
155   C-c . gs: `ecb-goto-window-sources'     (was C-c . s)
156   C-c . gm: `ecb-goto-window-methods'     (was C-c . m)
157   C-c . gh: `ecb-goto-window-history'     (was C-c . h)
158   C-c . gb: `ecb-goto-window-speedbar'    (was C-c . bw)
159   C-c . gc: `ecb-goto-window-compilation' (was C-c . c)
161   
162 Upgrading from version < 1.95:
163 ------------------------------
165 Some default key-bindings have changed; the new bindings are:
167   C-c . r:  `ecb-rebuild-methods-buffer' (was not bound before)
168   C-c . lc: `ecb-change-layout'          (was C-c . l)
169   C-c . lr: `ecb-redraw-layout'          (was C-c . r)
170   C-c . lt: `ecb-toggle-layout'          (was C-c . t)
171   C-c . lw: `ecb-toggle-ecb-windows'     (was C-c . w)
173 ECB now requires speedbar. ECB needs a version >= 0.14beta1.
175 For XEmacs now the package c-support (contains hideshow.el) has to be
176 installed.
179 Upgrading from versions < 1.92:
180 --------------------------------
182 The type of the option `ecb-truncate-lines' has changed.
183 ECB autom. upgrades the old value of this option to its new type!
186 Upgrading from version 1.80:
187 ----------------------------
189 The type or name of the following options has changed:
191 - ecb-layout-nr: New name is ecb-layout-name
192 - ecb-toggle-layout-sequence: New type
193 - ecb-major-modes-activate: New type
194 - ecb-layout-window-sizes: New type
195 - ecb-show-sources-in-directories-buffer: New type
196 - ecb-cache-directory-contents: New type
197 - ecb-source-file-regexps: New type
198 - ecb-show-ecb-windows-hook: New name is ecb-show-ecb-windows-before-hook
199 - ecb-hide-ecb-windows-hook: New name is ecb-hide-ecb-windows-before-hook
201 ECB autom. upgrades the values of these options to theirs new names/types!
204 Upgrading from version < 1.80:
205 ------------------------------
207 The type of the following options has changed:
209 - 'ecb-token-display-function'
210 - 'ecb-window-sync'
212 ECB has a new feature 'ecb-auto-compatibility-check' which enables a check for
213 incompatible or renamed ECB-options at ECB startup. These options are then
214 autom. upgraded to the new type or reset to the default-values of current
215 ECB-version if no upgrade is possible. All upgraded or reset options are
216 displayed to the user with their old and new values!
218 ECB now requires Semantic version 1.4 and eieio version 0.17! Any previous
219 beta version is not supported anymore!
222 Upgrading from any version < 1.60:
223 ----------------------------------
225 - The options `ecb-show-node-name-in-minibuffer',
226   `ecb-show-complete-file-name-in-minibuffer' and
227   `ecb-show-file-info-in-minibuffer' are gone and have been replaced by one
228   single new option `ecb-show-node-info-in-minibuffer' where you can define
229   separately for every tree-buffer when and which node info should be
230   displayed in the minibuffer
232   
233 Upgrading from versions < 1.52:
234 -------------------------------
236 + ECB now requires eieio >= 0.16 (see also README)
238 + The option ecb-prefix-key has been removed. Now all customization of
239   key-bindings is done via the new option ecb-key-map.
241 + ecb-layout-window-sizes is now an association list. If you have customized
242   this variable or used the ecb-store-window-sizes function, there will be an
243   error when drawing the ECB layout. Reset ecb-layout-window-sizes to it's
244   default value (nil) and store your window sizes using ecb-store-window-sizes.
246 + A new customization variable ecb-show-tokens controls the behavior of the
247   methods buffer. Read the documentation for more information.
249   
250 Upgrading from versions < 1.20:
251 -------------------------------
253 + Now mouse-1 and mouse-2 for opening source-files and jumping to
254   methods/variables is not longer the default key-binding. Please take a look
255   at the new options 'ecb-primary-secondary-mouse-buttons' and
256   'ecb-primary-mouse-jump-destination'.
258 + Now it is no longer necessary to bind in the ECB-hooks (ecb-activate-hook
259   and ecb-deactivate-hook) some standard-Emacs-keys for window-handling to the
260   ECB replacements for the related standard-functions to get proper
261   window-handling within the edit-window(s) of ECB.
263   Example: With ECB < 1.20 it was necessary to bind [C-x o] to
264   'ecb-other-window' in 'ecb-activate-hook' (and also "unbinding" it back to
265   the standard other-window in the 'ecb-deactivate-hook') to get a more
266   ECB-suitable other-window behavior. Same for other window-keys.
268   This way will work also in ECB 1.20 but it is NOT the recommended way
269   because the new option 'ecb-advice-window-functions' makes this much easier
270   and better. Please read the documentation of this option exactly!
272 + Default-value of `ecb-other-window-jump-behavior' is now 'all.
274 + Interactively calling 'ecb-update-methods-buffer' is not longer necessary as
275   work-around for the bug, that sometimes the error "Wrong type argument,
276   integer-or-marker-p nil" is displayed after clicking onto a method/variable
277   in the ECB-method-buffer. This bug is fixed!
279 + For a complete list of changes and new features for versions > 1.20 see the
280   NEWS file.