Changes between Version 25 and Version 26 of ChangeLogMacro


Ignore:
Timestamp:
May 24, 2020, 8:59:49 AM (4 months ago)
Author:
figaro
Comment:

Expansion of functional description

Legend:

Unmodified
Added
Removed
Modified
  • ChangeLogMacro

    v25 v26  
    77This plugin adds a Wiki macro that displays the changelog for a repository path. As an example, it generates the changes applied as shown in the Recent changes section below.
    88
    9 Examples:
     9The !ChangeLog macro writes a log of the latest changes of a repository at a given path. Following variants are possible to use:
     10{{{
     111. [[ChangeLog(/path)]]
     122. [[ChangeLog(/path@rev)]]
     133. [[ChangeLog(/path@rev, limit)]]
     144. [[ChangeLog(/path@from-to)]]
     155. [[ChangeLog(/path, limit, rev)]]
     16}}}
     17
     181. Default repository is used if reponame is left out. To show the last five changes of the default repository:
     19{{{
     20[[ChangeLog(/)]]
     21}}}
     22
     23 To show the last five changes of the trunk folder in a named `otherrepo`:
     24 {{{
     25 [[ChangeLog(/otherrepo/trunk)]]
     26 }}}
     27
     282. The ending revision can be set. To show the last five changes up to revision 99:
     29{{{
     30[[ChangeLog(/otherrepo/trunk@99)]]
     31}}}
     32
     333. The limit can be set by an optional parameter. To show the last 10 changes, up to revision 99:
     34{{{
     35[[ChangeLog(/otherrepo/trunk@99, 10)]]
     36}}}
     37
     384. A range of revisions can be logged.
     39{{{
     40[[ChangeLog(/otherrepo/trunk@90-99)]]
     41}}}
     42
     43 To list all changes:
     44 {{{
     45 [[ChangeLog(/otherrepo/trunk@1-HEAD)]]
     46 }}}
     47
     48 Note that HEAD can be left out:
     49 {{{
     50 [[ChangeLog(/otherrepo/trunk@1-)]]
     51 }}}
     52
     535. For backwards compatibility, the revision can be stated as a third parameter:
     54{{{
     55[[ChangeLog(/otherrepo/trunk, 10, 99)]]
     56}}}
     57
     58 Both limit and rev may be keyword arguments:
     59 {{{
     60 [[ChangeLog(/otherrepo/trunk, limit=10, rev=99)]]
     61 }}}
     62
     63**Examples**:
    1064
    11651. Display change log for this plugin, back 3 revisions: