[rfa/doc] Revise ``obsolete''

Andrew Cagney
2002-05-15T00:19:47Z

[-- Attachment #1: Type: text/plain, Size: 139 bytes --]

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

[-- Attachment #2: diffs --]
[-- Type: text/plain, Size: 3796 bytes --]

2002-05-14 Andrew Cagney <ac131313@redhat.com>

* 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