aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPaul Eggert2014-11-19 11:29:40 -0800
committerPaul Eggert2014-11-19 11:37:56 -0800
commitcd2e816cd3ebf562c680ed15b53cf2a88a01f14f (patch)
tree40bb4e3db8a0cc25ca29a80a984bcb6b37d49699 /doc
parentff953bc93bb41ef573cd6962424ece340ad5a394 (diff)
downloademacs-cd2e816cd3ebf562c680ed15b53cf2a88a01f14f.tar.gz
emacs-cd2e816cd3ebf562c680ed15b53cf2a88a01f14f.zip
Lessen focus on ChangeLog files, as opposed to change log entries.
This is in preparation for generating the former automatically from the latter. * admin/notes/bugtracker, admin/notes/copyright, admin/notes/newfile: ChangeLog -> change log * admin/notes/changelogs: Remove, merging old contents to ... * admin/notes/repo: ... here. * doc/emacs/maintaining.texi (Change Log): Mention that ChangeLog files may be copied to or from a version control system. * doc/emacs/trouble.texi (Sending Patches): Point to the commit messages. * doc/lispref/intro.texi (Acknowledgments): ChangeLog file -> change log entries. * doc/lispref/tips.texi (Library Headers): Emacs uses a version control system. * etc/CONTRIBUTE: Give advice about git commit messages and how to generate proposed patches containing them.
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/ChangeLog7
-rw-r--r--doc/emacs/maintaining.texi8
-rw-r--r--doc/emacs/trouble.texi6
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/intro.texi2
-rw-r--r--doc/lispref/tips.texi6
6 files changed, 25 insertions, 10 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index a72c2a8915c..e307ff3bd3a 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,10 @@
12014-11-19 Paul Eggert <eggert@cs.ucla.edu>
2
3 Lessen focus on ChangeLog files, as opposed to change log entries.
4 * maintaining.texi (Change Log): Mention that ChangeLog files may
5 be copied to or from a version control system.
6 * trouble.texi (Sending Patches): Point to the commit messages.
7
12014-11-19 Eli Zaretskii <eliz@gnu.org> 82014-11-19 Eli Zaretskii <eliz@gnu.org>
2 9
3 * maintaining.texi (Switching Branches): Mention "C-x v r". 10 * maintaining.texi (Switching Branches): Mention "C-x v r".
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index fef3cdea529..dd1c8269096 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1474,9 +1474,11 @@ different revision with @kbd{C-u C-x v v}.
1474@cindex change log 1474@cindex change log
1475 Many software projects keep a @dfn{change log}. This is a file, 1475 Many software projects keep a @dfn{change log}. This is a file,
1476normally named @file{ChangeLog}, containing a chronological record of 1476normally named @file{ChangeLog}, containing a chronological record of
1477when and how the program was changed. Sometimes, there are several 1477when and how the program was changed. Sometimes, these files are
1478change log files, each recording the changes in one directory or 1478automatically generated from the change log entries stored in version
1479directory tree. 1479control systems, or are used to generate these change log entries.
1480Sometimes, there are several change log files, each recording the
1481changes in one directory or directory tree.
1480 1482
1481@menu 1483@menu
1482* Change Log Commands:: Commands for editing change log files. 1484* Change Log Commands:: Commands for editing change log files.
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi
index 09260a1e5a9..5f3cf9223eb 100644
--- a/doc/emacs/trouble.texi
+++ b/doc/emacs/trouble.texi
@@ -1137,9 +1137,9 @@ new function, all you need to say about it is that it is new. If you
1137feel that the purpose needs explaining, it probably does---but put the 1137feel that the purpose needs explaining, it probably does---but put the
1138explanation in comments in the code. It will be more useful there. 1138explanation in comments in the code. It will be more useful there.
1139 1139
1140Please read the @file{ChangeLog} files in the @file{src} and 1140Please look at the change log entries of recent commits to see what
1141@file{lisp} directories to see what sorts of information to put in, 1141sorts of information to put in, and to learn the style that we use.
1142and to learn the style that we use. @xref{Change Log}. 1142@xref{Change Log}.
1143 1143
1144@item 1144@item
1145When you write the fix, keep in mind that we can't install a change that 1145When you write the fix, keep in mind that we can't install a change that
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 9123194d7eb..363e7aecd33 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,9 @@
12014-11-19 Paul Eggert <eggert@cs.ucla.edu>
2
3 Lessen focus on ChangeLog files, as opposed to change log entries.
4 * intro.texi (Acknowledgments): ChangeLog file -> change log entries.
5 * tips.texi (Library Headers): Emacs uses a version control system.
6
12014-11-09 Glenn Morris <rgm@gnu.org> 72014-11-09 Glenn Morris <rgm@gnu.org>
2 8
3 * Makefile.in (version): Remove variable. 9 * Makefile.in (version): Remove variable.
diff --git a/doc/lispref/intro.texi b/doc/lispref/intro.texi
index 0c5346fbb63..1cd79bb2265 100644
--- a/doc/lispref/intro.texi
+++ b/doc/lispref/intro.texi
@@ -552,4 +552,4 @@ Trost, Rickard Westman, Jean White, Eduard Wiebe, Matthew Wilding,
552Carl Witty, Dale Worley, Rusty Wright, and David D. Zuhn. 552Carl Witty, Dale Worley, Rusty Wright, and David D. Zuhn.
553 553
554 For a more complete list of contributors, please see the relevant 554 For a more complete list of contributors, please see the relevant
555ChangeLog file in the Emacs sources. 555change log entries in the Emacs source repository.
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index d8b906d3bfe..f7f07e8fb74 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -1062,9 +1062,9 @@ context.
1062@item ;;; Change Log: 1062@item ;;; Change Log:
1063This begins an optional log of changes to the file over time. Don't 1063This begins an optional log of changes to the file over time. Don't
1064put too much information in this section---it is better to keep the 1064put too much information in this section---it is better to keep the
1065detailed logs in a separate @file{ChangeLog} file (as Emacs does), 1065detailed logs in a version control system (as Emacs does) or in a
1066and/or to use a version control system. @samp{History} is an 1066separate @file{ChangeLog} file. @samp{History} is an alternative to
1067alternative to @samp{Change Log}. 1067@samp{Change Log}.
1068 1068
1069@item ;;; Code: 1069@item ;;; Code:
1070This begins the actual code of the program. 1070This begins the actual code of the program.