Re: [Qemu-devel] [PATCH v4 1/6] add documenation for new backup framework

[Stefan Hajnoczi]

On Thu, Feb 21, 2013 at 05:14:04AM +0000, Dietmar Maurer wrote:
> > Thanks for writing this up.  I don't think docs/backup.txt should be 
> > committed
> > as-is though because it refers to you proposing this patch series.  Once 
> > merged
> > some of this document will no longer be relevant.
> 
> Why will it be no longer relevant? It explain the basic idea.
>  
> > You could include this in the patch series cover letter instead.
> 
> I use 'git' to have a versioning system. using cover-lettter instead defeats 
> that purpose.

It's a statement about the patch series at a given point in time.  It
will quickly become outdated on the code is extended/modified.

I guess the cover letter is the wrong place, but commit messages would
be the right place.  Then it is versioned by git but refers to a
specific tree so it doesn't become outdated like a file in the source
tree would.

Also, "Please let us know if you know an existing format which
provides the same functionality" sounds like you are addressing patch
reviewers.

Stefan