From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 8866 invoked by alias); 15 May 2002 00:19:47 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 8849 invoked from network); 15 May 2002 00:19:46 -0000 Received: from unknown (HELO localhost.redhat.com) (24.112.240.27) by sources.redhat.com with SMTP; 15 May 2002 00:19:46 -0000 Received: from cygnus.com (localhost [127.0.0.1]) by localhost.redhat.com (Postfix) with ESMTP id 426473E60 for ; Tue, 14 May 2002 20:19:49 -0400 (EDT) Message-ID: <3CE1A9A5.3080302@cygnus.com> Date: Tue, 14 May 2002 17:19:00 -0000 From: Andrew Cagney User-Agent: Mozilla/5.0 (X11; U; NetBSD macppc; en-US; rv:1.0rc1) Gecko/20020429 X-Accept-Language: en-us, en MIME-Version: 1.0 To: gdb-patches@sources.redhat.com Subject: [rfa/doc] Revise ``obsolete'' Content-Type: multipart/mixed; boundary="------------050809020100090209060104" X-SW-Source: 2002-05/txt/msg00573.txt.bz2 This is a multi-part message in MIME format. --------------050809020100090209060104 Content-Type: text/plain; charset=us-ascii; format=flowed Content-Transfer-Encoding: 7bit Content-length: 139 Minor cleanup. Main thing is to use @enumerate for the list of tasks. That way people can say I'm ``Obosolete stage 4'' :-) ok, Andrew --------------050809020100090209060104 Content-Type: text/plain; name="diffs" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="diffs" Content-length: 3796 2002-05-14 Andrew Cagney * gdbint.texinfo (Releasing GDB): Rename ``Obsoleting any code'' to ``Obsoleting code''. Revise. Index: gdbint.texinfo =================================================================== RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v retrieving revision 1.84 diff -p -r1.84 gdbint.texinfo *** gdbint.texinfo 13 May 2002 17:20:59 -0000 1.84 --- gdbint.texinfo 15 May 2002 00:17:28 -0000 *************** This means that changes such as adding a *** 5037,5077 **** reason) support for a new host are considered acceptable.} ! @section Obsolete any code Before anything else, poke the other developers (and around the source code) to see if there is anything that can be removed from @value{GDBN} (an old target, an unused file). Obsolete code is identified by adding an @code{OBSOLETE} prefix to every ! line. Doing this means that it is easy to identify obsolete code when ! grepping through the sources. ! The process has a number of steps and is intentionally slow --- this is ! to mainly ensure that people have had a reasonable chance to respond. ! Remember, everything on the internet takes a week. ! @itemize @bullet @item ! announce the change on @email{gdb@@sources.redhat.com, GDB mailing list} @item ! wait a week or so @item ! announce the change on @email{gdb-announce@@sources.redhat.com, GDB ! Announcement mailing list} @item ! wait a week or so @item ! go through and edit all relevant files and lines (e.g., in ! @file{configure.tgt}) so that they are prefixed with the word ! @code{OBSOLETE}. ! @end itemize - @emph{Maintainer note: Removing old code, while regrettable, is a good - thing. Firstly it helps the developers by removing code that is either - no longer relevant or simply wrong. Secondly since it removes any - history associated with the file (effectively clearing the slate) the - developer has a much freer hand when it comes to fixing broken files.} @section Before the Branch --- 5037,5086 ---- reason) support for a new host are considered acceptable.} ! @section Obsoleting code Before anything else, poke the other developers (and around the source code) to see if there is anything that can be removed from @value{GDBN} (an old target, an unused file). Obsolete code is identified by adding an @code{OBSOLETE} prefix to every ! line. Doing this means that it is easy to identify something that has ! been obsoleted when greping through the sources. ! The process is done in stages --- this is mainly to ensure that the ! wider @value{GDBN} community has a reasonable opportunity to respond. ! Remember, everything on the Internet takes a week. ! @enumerate @item ! Post the proposal on @email{gdb@@sources.redhat.com, the GDB mailing ! list} Creating a bug report to track the task's state, is also highly ! recommended. @item ! Wait a week or so. @item ! Post the proposal on @email{gdb-announce@@sources.redhat.com, the GDB ! Announcement mailing list}. @item ! Wait a week or so. @item ! Go through and edit all relevant files and lines so that they are ! prefixed with the word @code{OBSOLETE}. ! @item ! Wait until the next GDB version, containing this obsolete code, has been ! released. ! @item ! Remove the obsolete code. ! @end enumerate ! ! @noindent ! @emph{Maintainer note: While removing old code is regrettable it is ! hopefully better for @value{GDBN}'s long term development. Firstly it ! helps the developers by removing code that is either no longer relevant ! or simply wrong. Secondly since it removes any history associated with ! the file (effectively clearing the slate) the developer has a much freer ! hand when it comes to fixing broken files.} @section Before the Branch --------------050809020100090209060104--