Home | Trees | Indices | Help |
---|
|
object --+ | Patchlog
Log entry associated to a revision. May be produced by `Revision.patchlog` or `ArchSourceTree.iter_logs()`. It provides an extensive summary of the associated changeset, a natural language description of the changes, and any number of user-defined extension headers. Patchlogs are formatted according to RFC-822, and are parsed using the standard email-handling facilities. Note that the patchlog text is not actually parsed before it is needed. That deferred evaluation feature is implemented in the `_parse` method. The fundamental accessors are `__getitem__`, which give the text of a named patchlog header, and the `description` property which gives the text of the patchlog body, that is anything after the headers. Additional properties provide appropriate standard conversion of the standard headers.
Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
Properties | |
continuation Deprecated. |
|
continuation_of Ancestor of tag revisions. |
|
creator User id of the the creator of the associated revision. |
|
date Time of the associated revision. |
|
description Patchlog body, a long natural language description. |
|
fromlib | |
merged_patches Revisions merged in this revision. |
|
modified_files Names of source files modified in the associated revision. |
|
new_files Source files added in the associated revision. |
|
new_patches New-patches header as an iterable of Revision. |
|
removed_files Names of source files removed in the associated revision. |
|
renamed_files Source files renames in the associated revision. |
|
revision Revision associated to this patchlog. |
|
summary Patchlog summary, a one-line natural language description. |
|
tree | |
Inherited from |
Method Details |
Text of a patchlog header by name. :param header: name of a patchlog header. :type header: str :return: text of the header, or None if the header is not present. :rtype: str, None |
Patchlog associated to the given revision. The patchlog may be retrieved from the provided ``tree``, from the revision library if ``fromlib`` is set, or from the archive. :param tree: source tree to retrieve the patchlog from. :type tree: `ArchSourceTree`, None :param fromlib: retrieve the patchlog from the revision library. :type fromlib: bool :raise ValueError: tree and fromlib are both set.
|
repr(x)
|
Deprecated. Ancestor of tag revisions. None for commit and import revisions. :rtype: `Revision`, None. :see: `Patchlog.continuation_of` |
Deprecated. User id of the the creator of the associated revision. :rtype: str :see: `Patchlog.creator` |
Deprecated. For the description of the local time tuple, see the documentation of the `time` module. :rtype: local time tuple :see: `Patchlog.date` |
Deprecated. Patchlog body, a long natural language description. :rtype: str :see: `Patchlog.description` |
Deprecated. Revisions merged in this revision. That is the revisions listed in the New-patches header except the revision of the patchlog. :rtype: iterable of `Revision` :see: `Patchlog.merged_patches` |
Deprecated. Names of source files modified in the associated revision. :rtype: iterable of `FileName` |
Deprecated. Source files added in the associated revision. :rtype: iterable of `FileName` :see: `Patchlog.new_files` |
Deprecated. New-patches header as an iterable of Revision. :rtype: iterable of `Revision` :see: `Patchlog.new_patches` |
Deprecated. Names of source files removed in the associated revision. :rtype: iterable of `FileName` |
Deprecated. Source files renames in the associated revision. Dictionnary whose keys are old names and whose values are the corresponding new names. Explicit file ids are listed in addition to their associated source file. :rtype: dict |
Deprecated. Revision associated to this patchlog. :rtype: `Revision` :see: `Patchlog.revision` |
Deprecated. Patchlog summary, a one-line natural language description. :rtype: str :see: `Patchlog.summary` |
List of 2-tuples containing all headers and values. :rtype: list of 2-tuple of str |
Property Details |
continuationDeprecated. Ancestor of tag revisions. None for commit and import revisions. :type: `Revision`, None. :see: `Patchlog.continuation_of`
|
continuation_ofAncestor of tag revisions. None for commit and import revisions. :type: `Revision`, None.
|
creatorUser id of the the creator of the associated revision. :type: str
|
dateTime of the associated revision. For the description of the local time tuple, see the documentation of the `time` module. :type: local time tuple
|
descriptionPatchlog body, a long natural language description. :type: str
|
fromlib
|
merged_patchesRevisions merged in this revision. That is the revisions listed in the New-patches header except the revision of the patchlog. :type: iterable of `Revision`
|
modified_filesNames of source files modified in the associated revision. :type: iterable of `FileName`
|
new_filesSource files added in the associated revision. :type: iterable of `FileName`
|
new_patchesNew-patches header as an iterable of Revision. Patchlogs added in this revision. :type: iterable of `Revision`
|
removed_filesNames of source files removed in the associated revision. :type: iterable of `FileName`
|
renamed_filesSource files renames in the associated revision. Dictionnary whose keys are old names and whose values are the corresponding new names. Explicit file ids are listed in addition to their associated source file. :type: dict
|
revisionRevision associated to this patchlog. :type: `Revision`
|
summaryPatchlog summary, a one-line natural language description. :type: str
|
tree
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0beta1 on Wed Sep 5 09:53:13 2007 | http://epydoc.sourceforge.net |