This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] gdb/source.c: Fix source path substitution


> > > Will do. I take it this info belongs in the commit message, or would
> > > you rather it be a cover letter-type email?
> > 
> > Can you explain which info you are referring to?
> The details concerning the issue that I'm fixing

Generally speaking, the best place for explaining why you do what
you do is the code. The more goes into the code, the better (usually).
The rest should be in the revision log. The idea is to help us avoid
doing most of the archeology based purely on the repository. Tracking
emails is quite a bit more labor-intensive...

For an example of a commit that I thought was pretty nice, take a look at:

    commit 6a3cb8e88a739c967bb9b2d8774bf96b87a7fda4
    Author: Pedro Alves <palves@redhat.com>
    Date:   Wed May 21 18:30:47 2014 +0100
    Allow making GDB not automatically connect to the native target.

It provides the context, shows what we had before, what we get now,
motivation, etc.

> One additional question that I had that was not answered on the IRC
> channel is I wanted some validation that such a simple change does
> not require copyright assignment since this fixes existing functionality
> and provides no new, patentable functionality.

If you keep your contributions to obvious changes, and/or small ones,
they are deemed "not legally significant", and we can accept one
or two of them. The guideline is that it should be under 15 lines.

-- 
Joel


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]