On Fri, Sep 30, 2016 at 11:48:44AM +0200, Kashyap Chamarthy wrote: > On Fri, Sep 30, 2016 at 04:53:38PM +0800, Wang WeiWei wrote: > > Kevin Wolf's advice: > > http://lists.gnu.org/archive/html/qemu-devel/2016-09/msg02391.html > > IIUC, what Stefan meant is to write a simple descriptive commit message > that explains why this change is necessary -- the above URL might have > context, but having it spelled out in the Git commit message will be > useful when someone is examining Git history offline. > > I think Stefan was looking for something like (came up with this after > reading the above thread): > > QAPI: BlockdevOptionsReplication: Clarify 'top-id' parameter usage > > In primary mode, the replication driver will ignore 'top-id' > parameter, thus it must not be supplied. Explicitly spell that out in > the QAPI schema for BlockdevOptionsReplication.
Yes. Posting just a URL as the commit description is not enough. I tried to explain the purpose of commit messages/descriptions in my previous reply. You can read a lot more about it elsewhere too: http://chris.beams.io/posts/git-commit/ (The key points are the introduction and "7. Use the body to explain what and why vs. how") Stefan
signature.asc
Description: PGP signature