Changes between Version 30 and Version 31 of TracDev/ApiChanges/0.12

Timestamp:

Apr 26, 2010, 9:19:45 PM (14 years ago)

Author:

Remy Blank

Comment:

Added a section about Repository.display_rev().

TracDev/ApiChanges/0.12

@@ -24 +24 @@
 == Modifications made to the 0.12 API ==
 === Modified Interfaces ===
-==== `IWikiMacroProvider` ^[source:trunk/trac/wiki/api.py@8372:85#L72 (0.12)] [source:branches/0.11-stable/trac/wiki/api.py@8372:90#L77 (0.11)]^ ==== #IWikiMacroProvider
+==== `IWikiMacroProvider`            ^[source:trunk/trac/wiki/api.py@8372:85#L72 (0.12)] [source:branches/0.11-stable/trac/wiki/api.py@8372:90#L77 (0.11)]^ ==== #IWikiMacroProvider
 Added an optional argument `args` to `IWikiMacroProvider.expand_macro()` to contain the shebang-line arguments when using wiki processor syntax. For example, with the following content:
 {{{
@@ -36 +36 @@
 See also #8204.
 
-==== `IWikiPageManipulator` ^[source:trunk/trac/wiki/api.py@8429:64#L52 (0.12)] [source:branches/0.11-stable/trac/wiki/api.py@8429:69#L57 (0.11)]^ ==== #IWikiPageManipulator
+==== `IWikiPageManipulator`          ^[source:trunk/trac/wiki/api.py@8429:64#L52 (0.12)] [source:branches/0.11-stable/trac/wiki/api.py@8429:69#L57 (0.11)]^ ==== #IWikiPageManipulator
 This interface has not actually been changed, but the implementation has been fixed so that it actually does what it promises, that is, ''validate a wiki page '''after it's been populated''' from user input''. Previously, `page.text` would contain the old text, and the new text would typically be retrieved with `req.args.get('text')` as a workaround.
 
@@ -147 +147 @@
 See #7116 for details on the `authz` argument, and #8731 for the `params` argument.
 
+==== `Repository` revision transformation ^[source:trunk/trac/versioncontrol/api.py@9559:875-882#L857 (0.12)]^ ====
+
+In addition to `Repository.normalize_rev(rev)`, which returns a (unique) normalized representation of the given revision (usually a full revision number or hash), and `Repository.short_rev(rev)`, which returns a short representation of the a revision to be used e.g. for source annotation, a new `Repository.display_rev(rev)` method can be implemented by version control backends to return a representation of a revision suitable for display to the user. By default, `display_rev()` calls `normalize_rev()`.
+
+See #9230 for details.
+
 ==== `Node` constructor  ^[source:trunk/trac/versioncontrol/api.py@9125:905#L887 (0.12)] [source:branches/0.11-stable/trac/versioncontrol/api.py@8353:368#L354 (0.11)]^ ==== #Node
 
@@ -183 +189 @@
 == New in the 0.12 API ==
 === New Classes ===
-==== `trac.cache.CacheManager` ^[source:trunk/trac/cache.py@#L91 (0.12)]^ ==== #CacheManager
+==== `trac.cache.CacheManager`                 ^[source:trunk/trac/cache.py@#L91 (0.12)]^ ==== #CacheManager
 
 There's a new cache subsystem in [source:trunk/trac/cache.py trac.cache] allowing Component instances to cache any data in a safe way. Whenever the cache entry is invalidated, the cached value will be automatically refreshed at the next retrieval, //even if the invalidation occurs in a different process//. This makes the `config.touch()` trick obsolete.
@@ -191 +197 @@
 See TracDev/CacheManager for details.
 
-==== `trac.util.text.empty` ^[source:trunk/trac/util/text.py@#L30 (0.12)]^ ==== #empty
+==== `trac.util.text.empty`                ^[source:trunk/trac/util/text.py@#L30 (0.12)]^ ==== #empty
 
 Special marker object used to represent a NULL value from the