[Freeciv-Dev] TODO/BUGS

[David Pfitzner <dwp@xxxxxxxxxxxxxx>]

The "Known Bugs" and TODO lists in the current sources are I think
a bit hidden at the end of the NEWS file (after lots of old news).
Also there is information about submitting bugs both in NEWS and
README.

This patch puts this information in new files TODO and BUGS.
I also updated the known bugs list (a bit), and the information
about submitting a bug (for GTK+ vs Xaw, and to reference the
Bug Tracking System).

Regards,
-- David

diff -N -u -r --exclude-from exclude freeciv-cvs/BUGS fc-adv/BUGS
--- freeciv-cvs/BUGS    Thu Jan  1 10:00:00 1970
+++ fc-adv/BUGS Wed Jun 23 21:55:02 1999
@@ -0,0 +1,94 @@
+BUGS
+====
+
+Freeciv 1.8.x is a "stable" release and is considered bug-free enough 
+for everyday use.  However if you do find a bug, we would really like to 
+know, so that we can fix it.  This file lists known bugs in this release, 
+and gives information about reporting new bugs.
+
+KNOWN BUGS:
+===========
+
+ - The easy AI is not easy enough for novice players.  If the AI is 
+   beating you up early in the game, try setting the "generator" server 
+   option to 2 or 3.  That is, in the server, before starting a game,
+   type:  set generator 2
+   or:    set generator 3
+
+ - The hard AI is not hard enough for very experienced players, and 
+   still does some stupid things.
+
+ - If you scroll to the bottom of the map, sometimes the bottom row
+   of squares is not fully visible.  As a work-around, try adjusting
+   the size of the client window.
+
+ - There may be some cases when the "red squares" in the city dialog
+   are not quite right.
+
+ - Units on goto can attack enemy units and cities unintentionally.
+
+REPORTING A BUG:
+================
+
+Here's what to do:
+
+ - Check that it is not one of the known bugs listed above!  :-)
+
+ - Check the Freeciv website, to ensure you're playing the latest
+   version.  (We may have already fixed the problem).
+
+   In particular, you might like to try a development snapshot,
+   from our CVS repository.  You can FTP them from:
+        <http://www.freeciv.org/latest.html>
+
+ - Check the Freeciv FAQ on the Freeciv website to see if we've
+   published a way to work around your bug.
+
+ - Check the Freeciv Bug Tracking System at:
+        <http://www.freeciv.org/cgi-bin/bugs>
+   to see if the bug has already been reported.
+
+ - Submit a bug report!  
+
+   You can submit a bug report either by sending email to 
+   <bugs@xxxxxxxxxxxxxxx>, or via the web at
+   <http://www.freeciv.org/cgi-bin/bugs>.
+
+   Or, if you want to send the Freeciv developers some comments 
+   but don't want to lodge a bug report, you can sent email to 
+   <freeciv-dev@xxxxxxxxxxx>, the Freeciv developer's mailing list.
+
+   What to include in your bug report:
+
+   - Describe the problem, including any messages that were displayed.
+
+   - Tell us the name and version of:
+
+       - The Operating System you're using.  You may find the
+         "uname -a" command useful.
+
+       - The version number of Freeciv.
+
+       - If you are using the Gtk+ client, the versions numbers
+         (if you know them) of your Gtk+, glib, and imlib libraries.
+
+       - If you are using the Xaw client, the version numbers (if you
+         know them) of the X libraries, the Xpm library, and the Xaw 
+         library, and particularly whether it is standard Xaw, or a 
+        variant such as Xaw3d, Xaw95, or Nextaw.
+
+       - If you're compiling from source code, the name
+         and version number of the compiler.
+
+       - If you're installing from a binary package, the name of
+         the package, the distribution it's for, and where you
+         got it from.
+
+   - If Freeciv "dumps core", then we may ask you to use a debugger to
+   give us a "stack trace".  You'll need the "core" file for this, so
+   please hold onto it for a while.
+
+
+For more information, as always, see the Freeciv website:
+
+            <http://www.freeciv.org>
diff -N -u -r --exclude-from exclude freeciv-cvs/Makefile.am fc-adv/Makefile.am
--- freeciv-cvs/Makefile.am     Tue Jun 22 23:00:16 1999
+++ fc-adv/Makefile.am  Wed Jun 23 21:54:40 1999
@@ -20,5 +20,5 @@
 
 SUBDIRS=       $(DSUBDIRS) common $(SSUBDIRS) $(CSUBDIRS)
 
-EXTRA_DIST=    HOWTOPLAY README.AI README.rulesets \
+EXTRA_DIST=    BUGS HOWTOPLAY README.AI README.rulesets \
                civ ser freeciv_hackers_guide.txt
diff -N -u -r --exclude-from exclude freeciv-cvs/Makefile.in fc-adv/Makefile.in
--- freeciv-cvs/Makefile.in     Tue Jun 22 23:00:16 1999
+++ fc-adv/Makefile.in  Wed Jun 23 21:54:40 1999
@@ -88,16 +88,16 @@
 
 SUBDIRS = $(DSUBDIRS) common $(SSUBDIRS) $(CSUBDIRS)
 
-EXTRA_DIST = HOWTOPLAY README.AI README.rulesets               civ ser 
freeciv_hackers_guide.txt
+EXTRA_DIST = BUGS HOWTOPLAY README.AI README.rulesets          civ ser 
freeciv_hackers_guide.txt
 
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
 mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
 CONFIG_HEADER = config.h
 CONFIG_CLEAN_FILES =  undep.sh
 DIST_COMMON =  README ./stamp-h.in AUTHORS COPYING ChangeLog INSTALL \
-Makefile.am Makefile.in NEWS THANKS acconfig.h acinclude.m4 aclocal.m4 \
-config.h.in configure configure.in install-sh missing mkinstalldirs \
-undep.sh.in
+Makefile.am Makefile.in NEWS THANKS TODO acconfig.h acinclude.m4 \
+aclocal.m4 config.h.in configure configure.in install-sh missing \
+mkinstalldirs undep.sh.in
 
 
 DISTFILES = $(DIST_COMMON) $(SOURCES) $(HEADERS) $(TEXINFOS) $(EXTRA_DIST)
diff -N -u -r --exclude-from exclude freeciv-cvs/NEWS fc-adv/NEWS
--- freeciv-cvs/NEWS    Fri Apr  2 15:17:48 1999
+++ fc-adv/NEWS Wed Jun 23 21:54:40 1999
@@ -146,39 +146,3 @@
  - Lots, and Lots, and Lots of donated patches. Thanks guys, keep 'em 
    coming!
 
-REPORTING A BUG:
-
-Freeciv 1.8.0 is a "stable" release and is considered bug-free enough 
-for everyday use.
-
-However if you do find one, please report it (or other problems) to
-the freeciv-dev mailing list.  For instructions on how to do this, see:
-
-  http://www.freeciv.org
-
-KNOWN BUGS:
-
- - The easy AI is not easy enough.  If the AI is beating you up early
-   in the game, try setting the "generator" server option to 2 or 3.
- - The hard AI is not hard enough, and still does some stupid things.
- - If you scroll to the bottom of the map, sometimes the bottom row
-   of squares is not fully visible.  As a work-around, try adjusting
-   the size of the client window.
- - There may be some cases when the "red squares" in the city dialog
-   are not quite right.  (In particular when you first reload a game
-   they don't appear straight away.)
- - A new server prompt is unnecessarily displayed for every turn.
- - Units on goto can attack enemy units and cities unintentionally;
-   this can be especially a problem with ships attacking cities.
-
-THINGS TO DO:
-
-In the next version, we hope to include:
-- Gtk+ client, as well as the current Xaw client. (certain)
-- Improved server commands. (certain)
-- Configurable races. (possible)
-- Wonders tiles. (Already drawn but not used yet.)
-
-Other projects in the pipeline are:  Alliances, Internationalisation
-(that is, multi-language support), City Plans, and more!
-Some other projects are listed at <http://www.freeciv.org>.
diff -N -u -r --exclude-from exclude freeciv-cvs/README fc-adv/README
--- freeciv-cvs/README  Sun Jun  6 16:02:21 1999
+++ fc-adv/README       Wed Jun 23 21:54:40 1999
@@ -401,48 +401,8 @@
 =====
 
 Found a bug?  We really want to hear from you so we can fix it.
-Here's what to do:
-
- - Check the Freeciv website, to ensure you're playing the latest
-   version.  (We may have already fixed the problem).
-
-   In particular, you might like to try a development snapshot,
-   from our CVS repository.  You can FTP them from:
-
-     http://www.freeciv.org/latest.html
-
- - Check the Freeciv FAQ on the Freeciv website to see if we've
-   published a way to work around your bug.
-
- - Send us an email!
-
-   - Address the email to "freeciv-dev", the Freeciv developer's
-   mailing list, as described below.
-
-   - Describe the problem, including any messages that were displayed.
-
-   - Tell us the name and version of:
-
-       - The Operating System you're using.  You may find the
-         "uname -a" command useful.
-
-       - The version number of Freeciv.
-
-       - If you know them, the version numbers of the X libraries, and
-         the Xpm library, and the Xaw library (and particularly 
-         whether it is standard Xaw, or a variant such as Xaw3d,
-         Xaw95, or Nextaw).
-
-       - If you're compiling from source code, the name
-         and version number of the compiler.
-
-       - If you're installing from a binary package, the name of
-         the package, the distribution it's for, and where you
-         got it from.
-
-   - If Freeciv "dumps core", then we may ask you to use a debugger to
-   give us a "stack trace".  You'll need the "core" file for this, so
-   please hold onto it for a while.
+See the file BUGS, for a list of known bugs in this release, and 
+information about reporting new bugs.
 
 
 Mailing lists:
diff -N -u -r --exclude-from exclude freeciv-cvs/TODO fc-adv/TODO
--- freeciv-cvs/TODO    Thu Jan  1 10:00:00 1970
+++ fc-adv/TODO Wed Jun 23 21:54:40 1999
@@ -0,0 +1,23 @@
+THINGS TO DO
+============
+
+Freeciv is quite mature, and we think its already a great game,
+but there are always things to add or improve.  This file lists 
+some new features which are being worked on, or are planned, or 
+desired.  (See also the file BUGS, for some known deficiencies.)
+
+TODO:
+
+- Internationalization (that is, multi-language support).
+- Make the government types configurable via rulesets.
+- Make the existing rulesets more flexible, especially for
+  City Improvements and Wonders.
+- Make the races/tribes/leaders/city-names configurable.
+- Allow alliances between players.
+- City Plans and other client improvements.
+- Ports to Win32 and Mac are being worked on.
+
+Information on other projects, and the Freeciv development 
+"roadmap", are available at the Freeciv website:
+
+            <http://www.freeciv.org>