NEWS

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