<html lang="en">
<head>
<title>Change Logs - PHP Mode Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="PHP Mode Manual">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Index-Menu.html#Index-Menu" title="Index Menu">
<link rel="next" href="Speedbar.html#Speedbar" title="Speedbar">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This manual documents PHP mode version 1.5.0 for
use with GNU Emacs.
Copyright (C) 2008 Aaron S. Hawley
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.2 or any later version published by the Free Software
Foundation; with no Invariant Sections, and no Cover Texts. A
copy of the license is included in the section entitled ``Copying
This Manual.''
A copy of the license is also available from the Free Software
Foundation Web site at `http://www.gnu.org/licenses/fdl.html'.
The document was typeset with
GNU Texinfo (http://www.texinfo.org/).
$Date: 2008-11-04 11:51:51 -0500 (Tue, 04 Nov 2008) $
$Revision: 90 $
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Change-Logs"></a>
Next: <a rel="next" accesskey="n" href="Speedbar.html#Speedbar">Speedbar</a>,
Previous: <a rel="previous" accesskey="p" href="Index-Menu.html#Index-Menu">Index Menu</a>,
Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr>
</div>
<h2 class="chapter">11 Change Logs</h2>
<p><a name="index-php_002dbeginning_002dof_002ddefun_002dregexp-270"></a><a name="index-add_002dlog_002dcurrent_002ddefun_002dheader_002dregexp-271"></a><!-- This is documented, because PHP mode explicitly supports -->
<!-- the features of add-log by setting the value for the -->
<!-- add-log-current-defun-header-regexp to -->
<!-- php-beginning-of-defun-regexp. This feature is -->
<!-- documented in the PHP manual, but it is worth advertising -->
<!-- to PHP programmers. -->
<p><a name="index-ChangeLog-272"></a><a name="index-file_002c-ChangeLog-273"></a>PHP mode can help generate <samp><span class="file">ChangeLog</span></samp> files, a
widely-adopted format for documenting the changes made to
source code–especially software. PHP mode and Emacs will
determine the current function, file name, author
information and date and use it all to prepare a properly
formatted <samp><span class="file">ChangeLog</span></samp> entry in the file.
<p><a name="index-Diff-mode-274"></a><a name="index-diff-file-275"></a><a name="index-file_002c-diff-276"></a><a name="index-patch-file-277"></a><a name="index-file_002c-patch-278"></a><a name="index-add_002dchange_002dlog_002dentry-279"></a>The <code>add-change-log-entry</code> commands can be run from
within a buffer containing a PHP buffer, or from a buffer in
Diff mode with a revision patch to a PHP source file.
See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Diff-Mode.html#Diff-Mode">Diff Mode</a>.
<a name="index-ChangeLog-entry-280"></a>
<a name="index-add-ChangeLog-entry-281"></a>
<a name="index-add_002dchange_002dlog_002dentry_002dother_002dwindow-282"></a>
<a name="index-C_002dx-4-a-283"></a>
<dl><dt><kbd>C-x 4 a</kbd><dd>Add an entry in a <samp><span class="file">ChangeLog</span></samp> file opened in another
window, or add a new line to the already begun entry
(<code>add-change-log-entry-other-window</code>). Provides the
file name and the respective function name, when applicable,
for the current point. The point can be in a PHP source
file, or in the hunk of a diff file.<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a> This
command will also add the current author and date to the
entry.
</dl>
<div class="footnote">
<hr>
<h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small> See <a href="http://emacswiki.org/cgi-bin/info-ref?find=Diff-Mode.html#Diff-Mode">Diff Mode</a>.</p>
<hr></div>
</body></html>
