diff options
| -rw-r--r-- | .gitattributes | 1 | ||||
| -rw-r--r-- | HACKING | 90 | ||||
| -rw-r--r-- | Makefile.am | 18 |
3 files changed, 32 insertions, 77 deletions
diff --git a/.gitattributes b/.gitattributes index 233cfcd7..f7c0ed7c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,6 +1,5 @@ # See ./bootstrap for some helpful ~/.gitconfig or .git/config settings # needed for using these attributes effectively. -ChangeLog merge=merge-changelog *.texi* diff=texinfo null.* diff merge iso8859.m4 diff merge @@ -154,70 +154,24 @@ and is not part of a release distribution. 5. Editing 'ChangeLog' ====================== +* The ChangeLog is generated from git commit comments. Each commit log + should start with a one-line summary, a blank line, and then a + ChangeLog-style entry for all affected files. However, it's fine -- + even recommended -- to write a few lines of prose describing the + change, when the summary and ChangeLog entries don't give enough of + the big picture. Omit the leading TABs that you're used to seeing in + a "real" ChangeLog file, but keep the maximum line length at 72 or + smaller, so that the generated ChangeLog lines, each with its leading + TAB, will not exceed 80 columns. As for the ChangeLog-style content, + please follow these guidelines: + + http://www.gnu.org/software/guile/changelogs/guile-changelogs_3.html + * When in doubt, check that emacs can syntax-color properly in change-log-mode. And preferably use emacs 'C-x 4 a' (add-change-log-entry-other-window) to open ChangeLog with an - appropriate new template. - -* If this change is by a different author, or on a different date to the - last entry start a new entry at the top of the file with the format - (note two spaces between each field): - -yyyy-mm-dd Name of Author <email@address> - -* If more than one person collaborated on the change, additional - authors can be listed on subsequent lines, thus: - -yyyy-mm-dd Name of Main Author <email@address>, - Name of Contributor <another@email.address> - -* Where a change author did not supply a copyright assignment, but the - changes they submitted were sufficiently trivial to commit in any case - (see the GCS for guidelines on this), then flag this against their - name in the header, thus: - -yyyy-mm-dd Name of Author <email@address> (tiny change) - -* Preferably the next part should be a description of the overall - purpose of the change, separated from the header by a blank line, - indented by 1 tab, and filled at column 72. The last character of the - description should be a colon, :. - -* Changes to each file come next. Each new file starts on a new line, - indented by 1 tab and starting with an asterisk and a space. Multiple - files can be listed here relative to $top_srcdir, and comma separated. - Names of functions (or sections as appropriate) to which the change - applies should be named inside parentheses and comma separated. If - this goes beyond column 72, then parens should be closed and re-opened - on the next line: - - * file, another/file, test/testcases/foo.test (func_foo) - (func_bar, func_baz): Description of changes. - -* If the change does not apply to particular functions (or sections), - the section list can be omitted: - - * file, another/file, test/testcases/foo.test: General changes. - -* If the changes are particular to certain architectures, they should be - listed after the functions in square brackets: - - * file, another/file (func_foo) [linux, solaris]: Description of - changes. - -* Subsequent changes in other files that are related to the same overall - enhancement or bugfix should be listed concurrently, without blank - lines. Always start a fresh line for a new file: - - * file, another/file (func_foo) [linux, solaris]: Description of - changes. - * doc/foo.texi (Invoking Foo): Document. - * NEWS: Updated. - -* If the change is in response to a problem reported by someone other - than the author, then credit them at the end of the description with: - - Reported by Reporter Name <email@address>. + appropriate new template, which you can then paste into your git + commit editing session. * See the GNU Coding Standards document for more details on ChangeLog formatting. @@ -225,8 +179,8 @@ yyyy-mm-dd Name of Author <email@address> (tiny change) 6. Formatting ============= -* Use space-only indentation in nearly all files (Makefile and - ChangeLogs being the exception). +* Use space-only indentation in nearly all files (Makefile inputs being + the exception). If you use Emacs and your m4 working directory name matches, this code in your ~/.emacs enables the right mode: @@ -290,8 +244,8 @@ yyyy-mm-dd Name of Author <email@address> (tiny change) In particular, ensure that the gnulib version is at least as new as the latest stable libtool release. -* Update the version number in NEWS and ChangeLog, and mention in README - whether the release is stable. See +* Update the version number in NEWS, and mention in README whether the + release is stable. See http://www.gnu.org/software/libtool/contribute.html for details of the numbering scheme (M4 uses a similar scheme to libtool, although intra-release versions carry more information thanks to @@ -337,9 +291,9 @@ yyyy-mm-dd Name of Author <email@address> (tiny change) See http://www.gnu.org/software/libtool/contribute.html for details of the numbering scheme. -* Update NEWS, README, and ChangeLog to start the intra-release changes, - and run `git commit'. Then run `git push origin refs/tags/v<version>' - to push the release tag and complete the release. +* Update NEWS and README to start the intra-release changes, and run + `git commit'. Then run `git push origin refs/tags/v<version>' to push + the release tag and complete the release. * For stable releases, update the webpages. Run `build-aux/gnu-web-doc-update', which runs `make web-manual' on a diff --git a/Makefile.am b/Makefile.am index c2c9cd39..d4326965 100644 --- a/Makefile.am +++ b/Makefile.am @@ -65,22 +65,24 @@ AM_CPPFLAGS += -Im4/gnu -I$(srcdir)/m4/gnu \ -Im4 -I$(srcdir)/m4 AM_LDFLAGS += $(OS2_LDFLAGS) EXTRA_DIST += bootstrap cfg.mk maint.mk .version .prev-version \ - $(config_macro_dir)/gnulib-cache.m4 $(gitlog_to_changelog) + $(config_macro_dir)/gnulib-cache.m4 BUILT_SOURCES += .version .version: - echo $(VERSION) > $@-t && mv $@-t $@ + $(AM_V_GEN)echo $(VERSION) > $@-t && mv $@-t $@ dist-hook: dist-tarball-version dist-tarball-version: - echo $(VERSION) > $(distdir)/.tarball-version + $(AM_V_GEN)echo $(VERSION) > $(distdir)/.tarball-version dist-hook: $(changelog) changelog_start_date = 2011-01-01 $(changelog): FORCE - $(AM_V_GEN)if test -d '$(srcdir)/.git'; then \ - $(gitlog_to_changelog) \ - --since=$(changelog_start_date) > '$@T'; \ - rm -f '$@'; mv '$@T' '$@'; \ - cat '$(changelog_old)' >> '$@'; \ + $(AM_V_GEN)if test -d '$(top_srcdir)/.git'; then \ + test -e '$(log_fix)' \ + && amend_git_log="--amend=$(log_fix)" \ + || amend_git_log=; \ + $(gitlog_to_changelog) $$amend_git_log \ + --since=$(changelog_start_date) > '$@T' \ + && rm -f '$@' && mv '$@T' '$@'; \ fi # Sort in traditional ASCII order, regardless of the current locale; |