On Wed, 12/02 16:20, Peter Xu wrote: > On Wed, Dec 02, 2015 at 09:11:31AM +0800, Fam Zheng wrote: > > On Tue, 12/01 21:28, Peter Xu wrote: > > > + > > > +## > > > +# @DUMP_COMPLETED > > > +# > > > +# Emitted when background dump has completed > > > +# > > > +# @error: #optional human-readable error string that provides > > > +# hint on why dump failed. > > > > Please explicitly mention that successful dump emits DUMP_COMPLETED without > > error, and failed dump emits DUMP_COMPLETED that has an error str. > > Ok. I can add more words to describe it. Maybe something like: > > # @error: #optional human-readable error string that provides > # hint on why dump failed. Only presents on failure. The > # user should not try to interpret the error string. > > How do you think about this one?
That looks ok.
