Fix documentation.

[wizard.git] / wizard / deploy.py

diff --git a/wizard/deploy.py b/wizard/deploy.py
index 89f8232c681d124be16859cf8cf67b9758e1f324..994ce278798629e285e9f61a50565b86a63f3140 100644 (file)
--- a/wizard/deploy.py
+++ b/wizard/deploy.py
@@ -510,12 +510,17 @@ class NotMigratedError(Error):
     The deployment contains a .scripts-version file, but no .git
     or .scripts directory.
     """
+    #: Directory of deployment
+    dir = None
     def __init__(self, dir):
         self.dir = dir
     def __str__(self):
         return """This installation was not migrated"""
 
 class AlreadyVersionedError(Error):
+    """The deployment contained a .git directory but no .scripts directory."""
+    #: Directory of deployment
+    dir = None
     def __init__(self, dir):
         self.dir = dir
     def __str__(self):
@@ -527,6 +532,9 @@ migration, this means that the user was versioning their
 install using Git."""
 
 class NotConfiguredError(Error):
+    """The install was missing essential configuration."""
+    #: Directory of unconfigured install
+    dir = None
     def __init__(self, dir):
         self.dir = dir
     def __str__(self):
@@ -536,6 +544,9 @@ ERROR: The install was well-formed, but not configured
 (essential configuration files were not found.)"""
 
 class CorruptedAutoinstallError(Error):
+    """The install was missing a .git directory, but had a .scripts directory."""
+    #: Directory of the corrupted install
+    dir = None
     def __init__(self, dir):
         self.dir = dir
     def __str__(self):
@@ -545,6 +556,9 @@ ERROR: Directory contains a .scripts directory,
 but not a .git directory."""
 
 class NotAutoinstallError(Error):
+    """The directory was not an autoinstall, due to missing .scripts-version file."""
+    #: Directory in question
+    dir = None
     def __init__(self, dir):
         self.dir = dir
     def __str__(self):
@@ -555,6 +569,9 @@ this is an autoinstalled application?
 """
 
 class NoTagError(Error):
+    """Deployment has a tag that does not have an equivalent in upstream repository."""
+    #: Missing tag
+    tag = None
     def __init__(self, tag):
         self.tag = tag
     def __str__(self):
@@ -563,6 +580,9 @@ class NoTagError(Error):
 ERROR: Could not find tag %s in repository.""" % self.tag
 
 class NoLocalTagError(Error):
+    """Could not find tag in local repository."""
+    #: Missing tag
+    tag = None
     def __init__(self, tag):
         self.tag = tag
     def __str__(self):
@@ -571,6 +591,9 @@ class NoLocalTagError(Error):
 ERROR: Could not find tag %s in local repository.""" % self.tag
 
 class InconsistentPristineTagError(Error):
+    """Pristine tag commit ID does not match upstream pristine tag commit ID."""
+    #: Inconsistent tag
+    tag = None
     def __init__(self, tag):
         self.tag = tag
     def __str__(self):
@@ -580,6 +603,9 @@ ERROR: Local pristine tag %s did not match repository's.  This
 probably means an upstream rebase occured.""" % self.tag
 
 class InconsistentScriptsTagError(Error):
+    """Scripts tag commit ID does not match upstream scripts tag commit ID."""
+    #: Inconsistent tag
+    tag = None
     def __init__(self, tag):
         self.tag = tag
     def __str__(self):
@@ -589,6 +615,9 @@ ERROR: Local scripts tag %s did not match repository's.  This
 probably means an upstream rebase occurred.""" % self.tag
 
 class HeadNotDescendantError(Error):
+    """HEAD is not connected to tag."""
+    #: Tag that HEAD should have been descendant of.
+    tag = None
     def __init__(self, tag):
         self.tag = tag
     def __str__(self):
@@ -599,12 +628,18 @@ means that an upstream rebase occurred, and new tags were
 pulled, but local user commits were never rebased.""" % self.tag
 
 class VersionDetectionError(Error):
+    """Could not detect real version of application."""
     def __str__(self):
         return """
 
 ERROR: Could not detect the real version of the application."""
 
 class VersionMismatchError(Error):
+    """Git version of application does not match detected version."""
+    #: Detected version
+    real_version = None
+    #: Version from Git
+    git_version = None
     def __init__(self, real_version, git_version):
         self.real_version = real_version
         self.git_version = git_version