Changeset 45 in tailor

Timestamp:

07/05/04 12:30:55 (9 years ago)

Author:

lele@…

Hash name:

20040705103055-97f81-f6e955487befd1c7819558028994f02ffb348362

Message:

Documentation on TailorizedProject?

File:

• vcpx/tailor.py (modified) (7 diffs)

vcpx/tailor.py

@@ -1 +1 @@
 #! /usr/bin/python
 # -*- mode: python; coding: utf-8 -*-
-# :Progetto: vcpx -- 
+# :Progetto: vcpx -- Frontend capabilities
 # :Creato:   dom 04 lug 2004 00:40:54 CEST
 # :Autore:   Lele Gaifax <lele@nautilus.homeip.net>
@@ -7 +7 @@
 
 """
+Implement the basic capabilities of the frontend.
+
+This implementation stores the relevant project information, needed to
+keep the whole thing going on, such as the last synced revision, in a
+unversioned file named `tailor.info` at the root.
 """
 
@@ -17 +22 @@
     
 class TailorizedProject(object):
-
+    """
+    A TailorizedProject has two main capabilities: it may be bootstrapped
+    from an upstream repository or brought in sync with current upstream
+    revision.
+    """
+    
     def __init__(self, root):
         import logging
@@ -37 +47 @@
                 
     def __saveStatus(self):
+        """
+        Save relevant project information in a persistent way.
+        """
+        
         from os.path import join, exists
 
@@ -49 +63 @@
         
     def __loadStatus(self):
+        """
+        Load relevant project information.
+        """
+        
         from os.path import join, exists
 
@@ -69 +87 @@
         Extract a copy of the `repository` at given `revision` in the `root`
         directory and initialize a target repository with its content.
+
+        The actual information on the project are stored in a text file.
         """
 
@@ -94 +114 @@
 
     def update(self):
+        """
+        Update an existing tailorized project.
+
+        Fetch the upstream changesets and apply them to the working copy.
+        Use the information stored in the `tailor.info` file to ask just
+        the new changeset since last bootstrap/synchronization.
+        """
+        
         from os.path import join