← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/fetch.py

  • Committer: Andrew Bennetts
  • Date: 2009-08-07 04:29:36 UTC
  • mto: This revision was merged to the branch mainline in revision 4608.
  • Revision ID: andrew.bennetts@canonical.com-20090807042936-na99ueqdbsks86wq
Elaborate some docstrings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/fetch.py
260
260
 
261
261
def _new_root_data_stream(
262
262
    root_keys_to_create, rev_id_to_root_id_map, parent_map, repo, graph=None):
 
263
    """Generate a texts substream of synthesised root entries.
 
264
 
 
265
    Used in fetches that do rich-root upgrades.
 
266
    
 
267
    :param root_keys_to_create: iterable of (root_id, rev_id) pairs describing
 
268
        the root entries to create.
 
269
    :param rev_id_to_root_id_map: dict of known rev_id -> root_id mappings for
 
270
        calculating the parents.  If a parent rev_id is not found here then it
 
271
        will be recalculated.
 
272
    :param parent_map: a parent map for all the revisions in
 
273
        root_keys_to_create.
 
274
    :param graph: a graph to use instead of repo.get_graph().
 
275
    """
263
276
    for root_key in root_keys_to_create:
264
277
        root_id, rev_id = root_key
265
278
        parent_keys = _parent_keys_for_root_version(
270
283
 
271
284
def _parent_keys_for_root_version(
272
285
    root_id, rev_id, rev_id_to_root_id_map, parent_map, repo, graph=None):
273
 
    """Get the parent keys for a given root id."""
 
286
    """Get the parent keys for a given root id.
 
287
    
 
288
    A helper function for _new_root_data_stream.
 
289
    """
274
290
    # Include direct parents of the revision, but only if they used the same
275
291
    # root_id and are heads.
276
292
    rev_parents = parent_map[rev_id]