← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/rio.py

  • Committer: Aaron Bentley
  • Date: 2007-03-09 06:39:54 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2330.
  • Revision ID: aaron.bentley@utoronto.ca-20070309063954-kla33k312hc97fkg
Add docs for MergeDirective and RIO-patch functions

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/rio.py
316
316
    else:     # didn't see any content
317
317
        return None    
318
318
 
 
319
 
319
320
def to_patch_lines(stanza, max_width=72):
 
321
    """Convert a stanza into RIO-Patch format lines.
 
322
 
 
323
    RIO-Patch is a RIO variant designed to be e-mailed as part of a patch.
 
324
    It resists common forms of damage such as newline conversion or the removal
 
325
    of trailing whitespace, yet is also reasonably easy to read.
 
326
 
 
327
    :param max_width: The maximum number of characters per physical line.
 
328
    :return: a list of lines
 
329
    """
320
330
    assert max_width > 6
321
331
    max_rio_width = max_width - 4
322
332
    lines = []
382
392
 
383
393
 
384
394
def read_patch_stanza(line_iter):
 
395
    """Convert an iterable of RIO-Patch format lines into a Stanza.
 
396
 
 
397
    RIO-Patch is a RIO variant designed to be e-mailed as part of a patch.
 
398
    It resists common forms of damage such as newline conversion or the removal
 
399
    of trailing whitespace, yet is also reasonably easy to read.
 
400
 
 
401
    :return: a Stanza
 
402
    """
385
403
    return read_stanza(_patch_stanza_iter(line_iter))