Re: please fix your ChangeLog entry

[Carlos O'Donell <carlos_odonell at mentor dot com>]

On 7/25/2012 2:22 PM, Roland McGrath wrote:
> The ChangeLog additions for your secure_getenv has several problems.
> 
> 1. ports/... changes do not go in the top-level ChangeLog.
>    Instead, each machine has a ports/ChangeLog.foo file.
>    Make sure the entries each of those use the right relative file name.
> 
> 2. This is all a single change, so it should be a single paragraph.
>    Blank lines between log entries indicate logically separate
>    changes, which belong in separate commits.
> 
> 3. The log item for a Versions file should look like:
> 	* stdlib/Versions (GLIBC_2.17): Add secure_getenv.
> 	(GLIBC_PRIVATE): Add __libc_secure_getenv.
> 
> 4. You never need to mention "Update copyright years."
>    That's implicit in every change.
> 
> 5. This intermingling is very confusing:
> 	* sysdeps/unix/sysv/linux/i386/nptl/libc.abilist: Add secure_getenv.
> 	* sysdeps/unix/sysv/linux/libc_fatal.c: Likewise.
> 	* sysdeps/unix/sysv/linux/powerpc/powerpc32/fpu/nptl/libc.abilist:
> 	Likewise.
>     It's unnatural to have a change to a C file in the middle of a
>     long list of .abilist changes and just "Likewise".  That
>     libc_fatal.c is already mentioned with a meaningful message, so
>     this looks like it's just a stray line that shouldn't be there at all.
> 
> Please fix all these issues.  The commit message for that can just be
> something like, "Fix up ChangeLog entries."  If you're not positive
> you're doing it right, you can post the change here for review first.
> 
> I'm sorry I didn't catch these all before you committed.  When I saw
> Carlos had reviewed your last posted version, I assumed he had paid
> attention to all the details.

Sorry Roland, I must have been asleep at the wheel. I'll keep a closer
eye on the finer details of the patches.

Cheers,
Carlos.
-- 
Carlos O'Donell
Mentor Graphics / CodeSourcery
carlos_odonell@mentor.com
carlos@codesourcery.com
+1 (613) 963 1026