A ChangeLog must be included with every patch submitted.

Roughly, the format should be:


        PR bugzilla_component/NUMBER 
        PR bugzilla_component/NUMBER2
        * file (function): Change.
        (another function): Change. Change2.
        * file2: New file.
        * file3: Delete.

An example of changelog is:

2007-01-27  Manuel Lopez-Ibanez  <manu@gcc.gnu.org>

        PR c++/24924
        * c-opts.c (c_common_post_options): Handle C++ post-processing here. 
        Set also -pedantic-errors by default for the  preprocessor unless
        -fpermissive is given.

        * decl.c (cxx_init_decl_processing): Move command-line options
        processing to c-opts.c.

        * g++.dg/cpp/pedantic-errors.C: New.
        * g++.dg/cpp/permissive.C: New.

You can find more examples by browsing the archive of gcc-patches mailing list.

For the full and minute details, see the "Change Logs" chapter of the GNU Coding Standards. 1

Tools like vc-chlog can help create stub ChangeLog entries, which are already split up for the individual ChangeLog files and list files and functions that were changed.

  1. It's fair to say that in GCC's ChangeLogs, the part about "Conditional Changes" is more honoured in the breach than the observance... (1)

None: ChangeLog (last edited 2010-04-28 19:09:41 by ManuelLópezIbáñez)