Sanitize File::Find results using canonpath()
[deps.git] / NEWS
blobf34353b1c48a31f09748b433a0a61dcb587d1528
1 Version 0.13 - UNRELEASED
3  End-user-visible changes
5  * Added a node style to display the number of ingredient nodes and of
6    internal edges in a group (GroupStats), activated by default.
8  * Updated documentation.
10  Bugs fixed:
12  * The path-handling functions in the default project class were
13    confused by leading "./" in paths and failed to idendify some
14    dependencies.
16  * The root graph can now be included in arguments to
17    Transform::Consolidate, and "--consolidate 0-<N>" is now valid.
19  * The tulip renderer had been broken by an API change in 0.12.
21  * Workaround for a strange behaviour or ActivePerl 5.8.7 on Windows,
22    which caused dependencies in subdirs not to be found.
24  * Ingredientable::ingredients() method now always returns a list,
25    even in scalar context when there is only one ingredient.
27  Changes for the plugin writer:
29  * New node style attributes "label" and "extralabel" for the dot
30    renderer.
32  * Added support for edge styling, and support for "label" attribute
33    in the dot renderer.  New WeightLabel edge styler to replace old
34    ad-hoc code.
36  * Class moves and renames: transforms, styles.
38 ==================================================
40 Version 0.12 - 2006-02-03
42  End-user-visible changes
44  * Start of a renaming of the whole toolkit to DEPS (Dependency
45    Extraction and Processing System), graph-includes being only the
46    current user frontend.
48  * Graphs of grouped nodes now only include the defined groups.  The
49    new --consolidate flag is now available to merge such graphs in a
50    manner such that nodes of a given group-level, not included in any
51    higher-level group, are shown as well.  As a side-effect, this flag
52    also controls the highest group-level of the nodes to be drawn, in
53    place of the --group flag.
55  * The --group flag to render groups as node clusters is not available
56    any more.  It will come back in a later release, under a more suitable
57    name.
59  * The documentation previously found in the README file is now
60    available in DocBook XML format, in the doc/ directory.
62  Bugs fixed:
64  * Fixed the uniqueincludes project class, which has been broken since
65    the 0.6 reorganization.
67  * Calculation of edge weights was wrong.
69  Changes for the class writer:
71  * A project is now made of a set of graphs, themselves connected as a
72    graph representing the transformations used to produce them from the
73    other graphs.  Most APIs changed consequently.
75  * Projects are now expected to provide a nlevels() method matching
76    the number of grouping levels defined, and the filelabel() methods
77    are now allowed to return undef when a node does not belong to any
78    group at the requested level.
80  * Arbitrary transformations and styles can now be defined, although
81    no facility is provided yet by the master graph-includes script to
82    apply them, short of editing the script.  Currently available
83    transformations are "compatgroup" (use the old filelabel() mechanism
84    to define grouping levels), "consolidate" (merge several group levels
85    in a single graph to show non-grouped nodes as well), and
86    "transitivereduction".  The only currently available styler allows to
87    apply style attributes (like colors) to a node according to the group
88    it belongs to at a given grouping level.
90  Under the hood:
92  * Objects now get their hash locked in the constructors, to catch
93    typos, unwanted modifications, and other errors likely to occur
94    during subsequent refactorings.
96  * Introduced graph, node, and edge objects (splitted out from
97    project, along with relevant methods).  A project now has a stack
98    of graphs.
100  * Many other changes, fixing some bugs, and introducing brand new ones.
102 ==================================================
104 Version 0.11 - 2005-12-06
106  End-user-visible changes
108  * Generalized support for node coloring, with renderer::dot
109    supporting 2 coloring levels (background and outline)
111  * Improved portability to non-UNIX platforms, was successfully run on
112    win32.
114  * The C extractor now looks in for system headers in /usr/include by
115    default.
117  * The Perl extractor uses the default @INC value to locate system
118    headers.
120  Changes for the class writer:
122  * Per-language extractors can now declare a default system-include
123    path.
125  Bugs fixed:
127  * The --color flag was broken.
129 ==================================================
131 Version 0.10 - 2005-11-29
133  End-user-visible changes
135  * Added a --renderer flag to select another renderer than dot.
137  * Added preliminary support to use tulip as renderer.
139 ==================================================
141 Version 0.9.2 - 2005-11-2
143  * Start of a "tutorial" or "how to use" section in the doc.
145  * Explicitely written down the plan for the upcoming redesign.
147 ==================================================
149 Version 0.9.1 - 2005-06-01
151  Bugs fixed:
153  * Fixed a typo preventing the recursive search to see .c and .h
154    files.
156 ==================================================
158 Version 0.9 - 2005-06-01
160  Bugs fixed:
162  * Now fails nicely when no dependencies are found for any reason.
164  Other end-user-visible changes
166  * Command-line and version are now logged in the report file.
168  * New --version flag.
170  * Can now be run from source dir with no effort.
172  * Exit with usage on command-line.
174  * Updated usage summary with recent options.
176 ==================================================
178 Version 0.8 - 2005-05-26
180  End-user-visible changes
182  * Directory arguments are now searched for files, allowing to handle
183    projects with a large number of files.
185  * New --fileregexp option to override the per-language regexp used to
186    look for files inside directories.
188  * More statistics are available in the report file.
190  Changes for the class writer:
192  * extractors' getdeps methods cannot rely any more on @ARGV
193    containing the files list, and must get it from the FILES instance
194    variable.
196 ==================================================
198 Version 0.7 - 2005-05-10
200  Bugs fixed:
202  * The '.graph-includes.report' suffix used when using --output did
203    not include the first dot.
205  Other end-user-visible changes
207  * Visible edges are now labelled with the number of real dependencies
208    they represent, so we have some visual feedback of transitive
209    reduction.
211  * Huge performance boost for the transitive reduction.
213  * When cycles are present, the specific reduction selected is usually
214    a different one than in 0.6.1 and below, as a side-effect of
215    implementation changes.
217  * More documentation has been written.
219  Changes for the class writer:
221  * project::record_missing_dep was split out of project::record_dep.
223  * Dependencies are now stored in a hash instead of an array.
225  * The "label" special_edge attribute is now an array of strings, to
226    be presented on several lines.
228 ==================================================
230 Version 0.6.1 - 2005-04-26
232  Bugs fixed:
234  * Fixed the distribution which misses the C and perl extractors.
236 ==================================================
238 Version 0.6 - 2005-04-24
240  Bugs fixed:
242  * A typo in the graphincludes::params package prevented the
243    parameters default values to be used.
245  Command-line changes:
247  * New --language flag to select syntax of source files.
249  * Preliminary support for extracting perl dependencies, using
250    "--language perl"
252  Changes for the class writer:
254  * C-specific behaviour is now located in new extractor::C class.
256  * Changed special_edge() return value to an hash of graphviz node
257    attribute/value pairs
259  * More methods were moved from project::default up to ancestor
260    classes.
262 ==================================================
264 Version 0.5 - 2005-04-20
266  Command-line changes:
268  * --Include is now recognized as long form for -I.
270  * New --sysInclude option to specify system directories.  Included
271    files not found in the project, but found in those directories are
272    not considered as "not found".
274  Other end-user-visible changes
276  * Removed inconditional duplicate warnings flooding the output.
278  * Verbose diagnostics are now output unconditionally into a
279    graph-includes.report (or <file>.graph-includes.report) file.
281  Changes for the class writer:
283  * The constructor for the project classes now uses named parameters,
284    instead of positional parameters.
285  * Global parameters were moved to a new graphincludes::params package.
287 ==================================================
289 Version 0.4 - 2005-04-17
291  Command-line changes:
293  * Implemented cpp-like "-I <dir>" syntax for #include lookup,
294    dropping the infamous former ad-hoc heuristic.
296  Other end-user-visible changes
298  * `#include "..."' are now analyzed using the standard cpp semantics,
299    and `#include <...>' line are now considered as well.
301  Under the hood
303  * Many code cleanups.
305 ==================================================
307 Version 0.3 - 2005-04-14
309  Bugs fixed:
311  * Fixed a bug in the ad-hoc #include resolver which caused some
312    dependencies to be ignored
314  Command-line changes:
316  * New --paper option to get a graph printable on paper (for now, only
317    a4, a3 and letter)
319  Other end-user-visible changes
321  * More documentation has been written.
323 ==================================================
325 Version 0.2 - 2005-04-01
327  Bugs fixed:
329  * --output would reject its argument.
331  * --focus and --showdropped caused invalid output.
333  Command-line changes:
335  * New --prefixstrip option to make the graph more readable by
336    stripping a common prefix from all filenames.
338  * Obsolete (pre 0.1 !) --allfiles option was completely dropped.
340  Other end-user-visible changes
342  * More documentation has been written.
344  * The default project-class (and the sample wesnoth class) now
345    provide default singleton level-2 groups (so "--group 2-2" should
346    work on all projects).
348  Changes for the class writer:
350  * The tool expect a project class to build its dependency graph in an
351    init() method, instead of in the constructor.
353  * The project class constructor now takes an additional prefixstrip
354    argument.  More changes to come in this area to cause such changes
355    to be less disruptive in the future.
357  * A project class can now specify excuses for abusive dependencies,
358    to be shown in as edges of a different color, and with the excuse
359    as a label.
361 ==================================================
363 Version 0.1 - 2005-03-28
365  Initial public release.