]> granicus.if.org Git - php/commitdiff
MFH: remove all references to @ thing, as it's not recommended
authorAntony Dovgal <tony2001@php.net>
Thu, 5 Aug 2004 14:19:59 +0000 (14:19 +0000)
committerAntony Dovgal <tony2001@php.net>
Thu, 5 Aug 2004 14:19:59 +0000 (14:19 +0000)
README.CVS-RULES

index d661edd4f440ff7563de2330d9a29cfa73a6028d..cab77fc62c6683bbbc0f7738634d2165fa0b148e 100644 (file)
@@ -37,8 +37,11 @@ The next few rules are more of a technical nature.
       messages every day. Woe be to those who attempt to mess with it.
 
    2. All news updates intended for public viewing, such as new features,
-      bug fixes, improvements, etc., should go into the NEWS file. Also see
-      the note below about automatically updating NEWS in your commit message.
+      bug fixes, improvements, etc., should go into the NEWS file. 
+         
+      NB! Lines, starting with @ will go automagically into NEWS file, but
+      this is NOT recommended, though. Please, add news entries directly to 
+      NEWS file and don't forget to keep them adjusted and sorted.
 
    3. Do not commit multiple file and dump all messages in one commit. If you
       modified several unrelated files, commit each group separately and
@@ -59,14 +62,10 @@ The next few rules are more of a technical nature.
 The format of the commit messages is pretty simple.
 
 If a line begins with #, it is taken to be a comment and will not appear
-in the ChangeLog.  If the line begins with @, it will be redirected to the
-NEWS file. Everything else goes into the ChangeLog.
+in the ChangeLog. Everything else goes into the ChangeLog.
 
 It is important to note that if your comment or news logline spans multiple
-lines, you have to put # or @ at the beginning of _every_ such line. Every 
-entry in NEWS has to have a name after it, so if you did it with someone's 
-help, put both your names there. Your name WILL NOT be automatically put
-at the end of the NEWS entry - so, please provide it yourself.
+lines, you have to put # at the beginning of _every_ such line. 
 
 Example. Say you modified two files, datetime.c and string.c. In datetime.c
 you added a new format option for date() function, and in string.c you fixed
@@ -78,17 +77,12 @@ For datetime.c:
 
 (PHP date) Added new 'K' format modifier for printing out number of
            days until New Year's Eve.
-@- Added new 'K' format modifier that will output the number of days
-@  until New Year's Eve. (Bob)
 
 For string.c:
 (php_trim) Fixed a memory leak resulting from improper use of zval_dtor().
 # Man, that thing was leaking all over the place!
-@- Fixed memory leak in trim(). (Bob)
 
-The lines above marked with @ will go into NEWS file automagically, and the
-# lines will be omitted from the ChangeLog. Alternatively, you might want
-to modify NEWS file directly and not use the @ lines.
+The # lines will be omitted from the ChangeLog automagically.
 
 If you fix some bugs, you should note the bug ID numbers in your
 commit message. Bug ID should be prefixed by "#" for easier access to
@@ -97,12 +91,10 @@ bug report when developers are browsing CVS via. LXR or Bonsai.
 Example:
 
 Fixed pgsql notice handler double free crash bug. Bug #14016
-@ Fixed pgsql notice handler double free crash bug. Bug #14016
 
-If you don't see your messages in ChangeLog and NEWS right away, don't worry!
+If you don't see your messages in ChangeLog right away, don't worry!
 These files are updated once a day, so your stuff will not show up until
-somewhat later. Don't go adding stuff to NEWS by hand if you already put @
-lines in the commit message.
+somewhat later. 
 
 You can use LXR (http://lxr.php.net/) and Bonsai (http://bonsai.php.net/)
 to look at PHP CVS repository in various ways.