![]() System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/gnustep-base-doc/CodingStandards/gs-standards/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <title>ChangeLog Entries (Coding Standards for GNUstep Libraries)</title> <meta name="description" content="ChangeLog Entries (Coding Standards for GNUstep Libraries)"> <meta name="keywords" content="ChangeLog Entries (Coding Standards for GNUstep Libraries)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html" rel="up" title="Top"> <link href="Coding-Style.html" rel="next" title="Coding Style"> <link href="Introduction.html" rel="prev" title="Introduction"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {margin-left: 3.2em} div.lisp {margin-left: 3.2em} kbd {font-style: oblique} pre.display {font-family: inherit} pre.format {font-family: inherit} pre.menu-comment {font-family: serif} pre.menu-preformatted {font-family: serif} span.nolinebreak {white-space: nowrap} span.roman {font-family: initial; font-weight: normal} span.sansserif {font-family: sans-serif; font-weight: normal} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <span id="ChangeLog-Entries"></span><div class="header"> <p> Next: <a href="Coding-Style.html" accesskey="n" rel="next">Coding Style</a>, Previous: <a href="Introduction.html" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> </p> </div> <hr> <span id="ChangeLog-Entries-1"></span><h2 class="chapter">2 ChangeLog Entries</h2> <p>Always include a ChangeLog entry for work that you do. Look for the ChangeLog file in the current directory or look up to any number of parent directories. Typically there is one for each library. </p> <p>Emacs currently formats the header like this: </p> <div class="example"> <pre class="example">2000-03-11 Adam Fedor <fedor@gnu.org> </pre></div> <p>and formats changes to functions/methods like this: </p> <div class="example"> <pre class="example">* Source/NSSlider.m ([NSSlider -initWithFrame:]): </pre></div> <p>to which you add your own comments on the same line (with word wrapping). Although if you’re making similar changes to multiple methods, it’s ok to leave out the function/method name. </p> <p>Important: Changelog entries should state what was changed, not why it was changed. It’s more appropriate to put that in the source code, where someone can find it, or in the documentation. </p> </body> </html>