[Projects] GL 54: ChangeLogs & merge

2004-09-13 Akim Demaille <akim(a)epita.fr> * guidelines.texi: Fix uses of @samp instead of @example. (ChangeLog Do): Merges. (Top): Fix locations. --- /mnt/dload/guidelines/guidelines.txt 2004-08-26 11:56:36.000000000 +0200 +++ guidelines.txt 2004-09-13 12:21:29.000000000 +0200 @@ -1,17 +1,15 @@ LRDE Guidelines *************** - This document, last edited on August 26, 2004, is a guideline for LRDE -members. It is available under various forms: - - Maintain in a single HTML file(1). + This document, last edited on September 13, 2004, is a guideline for +LRDE members. It is available under various forms: + - Guidelines in a several HTML file(1). - - Maintain in several HTML files(2). + - Guidelines in PDF(2). - - Maintain in PDF(3). + - Guidelines in text(3). - - Maintain in text(4). - - - Maintain in Info(5). + - Guidelines in Info(4). Some sections are (almost) verbatim copies of texts written by Raphaël Poss. @@ -59,15 +57,13 @@ ---------- Footnotes ---------- - (1) `http://www.lrde.epita.fr/dload/guidelines/maintain.html'. - - (2) `http://www.lrde.epita.fr/dload/guidelines/maintain.split'. + (1) `http://www.lrde.epita.fr/dload/guidelines/guidelines.html'. - (3) `http://www.lrde.epita.fr/dload/guidelines/maintain.pdf'. + (2) `http://www.lrde.epita.fr/dload/guidelines/guidelines.pdf'. - (4) `http://www.lrde.epita.fr/dload/guidelines/maintain.txt'. + (3) `http://www.lrde.epita.fr/dload/guidelines/guidelines.txt'. - (5) `http://www.lrde.epita.fr/dload/guidelines/maintain.info'. + (4) `http://www.lrde.epita.fr/dload/guidelines/guidelines.info'. 1 Introduction ************** @@ -881,11 +877,32 @@ - ChangeLog entries are basically write-once, especially items far in the past: if you change them, one might have problems tracing a change - which description changed. Nevertheless, fix mistakes in recent - entries. If details on a patch are asked, it is probably the sign the + which description changed. Nevertheless, *fix mistakes in recent + entries*. If details on a patch are asked, it is probably the sign the ChangeLog was incomplete: complete it! Don't file a ChangeLog entry for ChangeLog entry fixes. + - When *merging a branch* add a tabulation to the added ChangeLog + headers, and past all this into your new ChangeLog. Here is an + example: + + 2003-10-01 Raphaël Poss <raph(a)lrde.epita.fr> + + Merge the following changes. + + 2003-10-01 Raphaël Poss <raph(a)lrde.epita.fr> + + * src/translate/translation.cc: Fix bug where reference to + temporaries were stored in the heap. + + 2003-09-30 Raphaël Poss <raph(a)lrde.epita.fr> + + * Synchronize with main project. + + [...] + + * src/misc/Makefile.am: Mention the new files. + 6.2.3 ChangeLog Don't --------------------- @@ -969,24 +986,24 @@ _2. Update your local copy_ To get the lastest changes: - `$ prcs merge' + $ prcs merge If you have not changed the prj file so far, run: - `$ prcs checkout myproject myproject.prj' + $ prcs checkout myproject myproject.prj This helps keeping the prj file clean. _3. Add and remove new/obsolete files_ Get the list of files prcs would add/remove: - `$ prcs populate -dn' + $ prcs populate -dn Generated files or junk files may be listed. Add them to the diff-ignore section of the .prj file. When `populate -dn' gives a clean list of new files, run: - `$ prcs populate -d' + $ prcs populate -d to add/remove effectively the new/old files into the .prj.