Rev 4888: Document the behavior of flush. in http://bazaar.launchpad.net/~jameinel/bzr/2.1-client-reconnect-819604

[John Arbash Meinel]

At http://bazaar.launchpad.net/~jameinel/bzr/2.1-client-reconnect-819604

------------------------------------------------------------
revno: 4888
revision-id: john at arbash-meinel.com-20110928145848-lrno0pmindirh1zz
parent: john at arbash-meinel.com-20110928145536-rahm8funuc23vfr4
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: 2.1-client-reconnect-819604
timestamp: Wed 2011-09-28 16:58:48 +0200
message:
  Document the behavior of flush.
-------------- next part --------------
=== modified file 'bzrlib/smart/medium.py'
--- a/bzrlib/smart/medium.py	2011-09-28 14:44:38 +0000
+++ b/bzrlib/smart/medium.py	2011-09-28 14:58:48 +0000
@@ -738,6 +738,9 @@
 
     def _flush(self):
         """See SmartClientStreamMedium._flush()."""
+        # Note: If flush were to fail, we'd like to raise ConnectionReset, etc.
+        #       However, testing shows that even when the child process is
+        #       gone, this doesn't error.
         osutils.until_no_eintr(self._writeable_pipe.flush)
 
     def _read_bytes(self, count):