[librep] Major doc clean-up: Removed or updated many capital letter files.



commit f0b858e9e7c588b379c238ce97e13fb4f7f9d5dc
Author: Teika kazura <teika lavabit com>
Date:   Sat Jul 17 18:18:17 2010 +0900

    Major doc clean-up: Removed or updated many capital letter files.

 AUTHORS            |    1 -
 BUGS               |    3 --
 HACKING            |    5 ---
 MAINTAINERS        |    4 --
 README             |   46 ++++++++++++++-------------
 THANKS             |   22 -------------
 TODO               |   21 ++----------
 TREE               |   85 ----------------------------------------------------
 man/interface.texi |    4 +-
 man/librep.texi    |   46 ++++++++++++++++++++++-----
 10 files changed, 67 insertions(+), 170 deletions(-)
---
diff --git a/MAINTAINERS b/MAINTAINERS
index 596bf62..d11a92d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1,7 +1,3 @@
-John Harper
-E-mail: jsh unfactored org
-Userid: jsh
-
 Christopher Bratusek
 E-mail: zanghar freenet de
 Userid: chrisb
diff --git a/README b/README
index 94fc167..c86b3c8 100644
--- a/README
+++ b/README
@@ -1,44 +1,46 @@
 [ this is -*-Text-*- ]
 
-This is librep, a Lisp system for UNIX. It contains a Lisp interpreter,
-byte-code compiler and virtual machine. Applications may use the Lisp
-interpreter as an extension language, or it may be used for stand-alone
-scripts.
+Complete documentation is given in info file.
+
+This is librep, a Lisp system for UNIX, the backend of Sawfish window
+manager. It contains a Lisp interpreter, byte-code compiler and
+virtual machine. Applications may use the Lisp interpreter as an
+extension language, or it may be used for stand-alone scripts.
 
 The Lisp dialect was originally inspired by Emacs Lisp, but with the
 worst features removed. It also borrows many ideas from Scheme.
 
-It is known to compile on at least Solaris/sparc and Linux/ix86; it is
-released under the terms of the GNU GPL, copyright John Harper
-<jsh pixelslut com>
+It is known to compile on at least Solaris/sparc and Linux, x86 and
+x86-64.
 
-For more details see:
+It is released under the terms of the GNU GPL, 
+copyright John Harper <jsh pixelslut com>
 
-	http://librep.sourceforge.net/
+Maintainer until Aug 2008: John Harper
+Maintainer since Aug 2008: Christopher Bratusek
 
-Browse the SVN tree at:
+For more details see:
 
-	http://svn.gnome.org/viewvc/librep/
+	http://sawfish.wikia.com/
 
-To compile this you'll need GNU make, the GNU MP library (see below)
-and GNU dbm installed. Basically, just do:
+To compile this you'll need GNU make, and GNU dbm
+installed. Basically, just do:
 
 	$ ./configure
 	$ make
 	$ make install
 
-(if building from the SVN tree use ./autogen.sh instead of ./configure)
-
 Notes
 =====
 
 64-bit systems
 --------------
 
-If you're on a 64-bit architecture you may want to look at the
-`--with-value-type' configure option. This is an implicitly signed
-integer type (i.e. `int', `long', etc) that is wide enough to store an
-arbitrary pointer without losing any bits.
+Basically support of 64-bit systems works, but if not, read this:
+
+You may want to look at the `--with-value-type' configure option. This
+is an implicitly signed integer type (i.e. `int', `long', etc) that is
+wide enough to store an arbitrary pointer without losing any bits.
 
 It should be detected automatically by the configure script, but if not
 there are two most likely required settings:
@@ -65,9 +67,9 @@ suffix and printf conversion of the chosen type.
 libgmp
 ------
 
-rep uses GNU MP for it's bignum/rational implementation; you can find
-it at any GNU mirror. GMP versions 2 and 3 are both known to work
-(though version 3 is recommended)
+rep optionally uses GNU MP for its bignum/rational implementation;
+you can find it at any GNU mirror. GMP versions 2 and 3 are both known
+to work (though version 3 is recommended)
 
 
 shared libraries
diff --git a/TODO b/TODO
index 255043c..e79782f 100644
--- a/TODO
+++ b/TODO
@@ -1,5 +1,9 @@
 [ This is -*-Indented-Text-*- ]
 
+This list is written by John Harper, the original author of Librep,
+but the current Sawfish community has little hope to accomplish any
+of them.
+
 TODO list for librep
 ********************
 
@@ -22,10 +26,6 @@ Outstanding bugs
 
  ! non-top-level compiled defvar's aren't quite right
 
- ! scheme define/lambda doesn't splice begin forms
-
- ! the scheme module fails some of the guile test.scm cases
-
  ! the first level lookup of foo#bar isn't cached
 
  ! interfaces aren't re-parsed when modules are reloaded
@@ -47,9 +47,6 @@ Outstanding bugs
 
  ! doesn't handle NaN or Inf in floats properly (at all)
 
- ! Putting a breakpoint in a .jaderc file doesn't work correctly; the
-   debugger is entered, but the commands don't work
-
  ! if load can't find the file, its error message is confusing
    (especially if the named file does exist, but no suffixed file
    exists)
@@ -91,8 +88,6 @@ General programming tasks:
 
    (generated when lexical bindings aren't heap allocated)
 
- + rename backquote* as quasiquote* -- helps scheme, doesn't affect rep
-
  + add restricted load to gaol? (same directory only?)
 
  + %make-structure shouldn't map names to structures itself
@@ -160,14 +155,6 @@ General programming tasks:
    [ partially done, there is a test framework now, but only a couple
    of modules define tests ]
 
- - scheme compilation is worse than rep compilation
-
-   should be able to make this a lot better, maybe not as good as rep
-   code (since the vm primitives are designed for that), but still a
-   lot better..
-
-   [ it's better now, but still room for improvement ]
-
  - the gc sucks
 
    is it possible to add a good (generational?) gc?
diff --git a/man/interface.texi b/man/interface.texi
index 33df169..f3c4365 100644
--- a/man/interface.texi
+++ b/man/interface.texi
@@ -7,8 +7,8 @@
 @cindex librep internals
 @cindex Internals
 
-Sorry, to be written. Some informations can be found at
- url{http://sawfish.wikia.com/wiki/Librep_Internals}.
+Sorry, it has little chance to be written. Some informations can be
+found at @url{http://sawfish.wikia.com/wiki/Librep_Internals}.
 
 @ignore
 This chapter will document the internals of @code{librep}, including
diff --git a/man/librep.texi b/man/librep.texi
index 15643c9..48acd2d 100644
--- a/man/librep.texi
+++ b/man/librep.texi
@@ -114,12 +114,15 @@ promises regarding the reliability of this software.
 @chapter Introduction
 @cindex Introduction
 
+For compilation instruction, read @file{README}.
+
 @menu
 * Overview::
-* Reporting bugs::              How to contact the maintainers
+* Reporting bugs/patches/etc::              How to contact the maintainers
+* Acknowledgment::
 @end menu
 
- node Overview, Reporting bugs, , Introduction
+ node Overview, Reporting bugs/patches/etc, , Introduction
 @section Overview
 
 @code{librep} is a dialect of Lisp, designed to be used both as an
@@ -164,10 +167,10 @@ Common Lisp and various Scheme implementations
 @item Extensible type, I/O, and file handling
 @end itemize
 
- node Reporting bugs, , Overview, Introduction
- section Reporting bugs
- cindex Reporting bugs
- cindex Bugs, reporting
+ node Reporting bugs/patches/etc, Acknowledgment , Overview, Introduction
+ section Reporting bugs/patches/etc
+ cindex Reporting bugs, patches, etc
+ cindex Bugs, patches, reporting
 
 If the @code{librep} interpreter crashes it's probably a bug (unless
 you're using the @code{rep-gtk} binding, in which case creating invalid
@@ -175,15 +178,40 @@ GTK widget hierarchies can easily crash the Lisp system). If the
 interpreter hangs such that sending it interrupt signals doesn't fix
 the problem, that's probably also a bug.
 
-To help me fix any bugs found please try to collect as much meaningful
+When reporting any bugs, please try to collect as much meaningful
 information as possible. This will hopefully include stack backtraces
 (of both the C and Lisp stacks if possible), what features are loaded,
 what you did immediately before triggering the bug, a description of
 your the system, etc dots{}
 
 Please send any bug reports to the mailing list:
- email{librep-list@@lists.sourceforge.net}. Alternatively, the author
-may be contacted at: @email{jsh@@users.sourceforge.net}.
+ email{sawfish-list@@gnome.org}.
+
+To make a patch, please use @code{git diff} or @code{diff -u}.
+
+ node Acknowledgment, , Reporting bugs/patches/etc, Introduction
+ section Acknowledgment
+ cindex Acknowledgment
+Thanks to:
+
+ itemize
+ item Henry Spencer for his excellent regexp matcher
+
+ item Ozan Yigit for SDBM
+
+ item Rick Sladkey for the Emacs backquote implementation
+
+ item Jamie Zawinski for the Emacs peephole optimiser patterns
+
+ item Yukihiro Nakai for the first rep-gettext implementation
+
+ item Mikolaj J. Habryn for being the first 64-bit guinea-pig, and for 
+building Debian packages
+
+ item Aron Griffis for porting to Tru64
+
+ item numerous other people for bug-reports and patches
+ end itemize
 
 @node News, Invocation, Introduction, Top
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]