Re: [README] Progress of 1.5.0 (renaming, configure rework, ebuild notes)

[Teika Kazura <teika lavabit com>]

Hi. 

Christopher Bratusek wrote:
> ... sawmill-defaults (or now: sawfish-defaults) is not a config-file.
> It's the out-of-the-box configuration

I misunderstood, as you have noticed. Thank you for pointing out. 

I was mislead by the faq, so I fixed it, and attached the patch. 
More precisely, the patch changes:
* Makefile.in 
  - Replaced the word 'sawmill' with 'sawfish'.
* README.IMPORTANT
  A bit of readability. 
  - The header line is added.
  - Emacs' org-mode style indent and bullets are given.
* man/faq.texi
  - Configuration part rewrite.
    - Easier to understand, less misleading.
    - 'Sawmill' -> 'sawfish'
  - that newer .jl is used over older .jlc files, in byte compilation
    section.

I know uppercase files under the top dir need update, but I put
higher priority to wiki improvements...

Timo Korvola wrote:
> We could replace sawfish-defaults.jl with a short file that displays a
> message about the name change.

We should always remember such user-friendly attitude, (yeah, one
often forgets it,) but REAMDE.IMPORTANT seems to suffice. (The latter 
turns out to be a pretty good idea.)

Teika kazura

diff -u -r trunk/Makefile.in mytrunk/Makefile.in
--- trunk/Makefile.in	2009-01-08 15:10:31.128316000 +0900
+++ mytrunk/Makefile.in	2009-01-09 20:09:08.487356490 +0900
@@ -1,21 +1,21 @@
-# Makefile.in for sawmill version 4
-# Copyright (C) 1998 John Harper <john dcs warwick ac uk>
+# Makefile.in for sawfish
+# Copyright (C) 1998 John Harper
 # $Id: Makefile.in,v 1.31 2003/04/03 02:24:42 jsh Exp $
 #
-# This file is part of sawmill.
+# This file is part of sawfish.
 #
-# sawmill is free software; you can redistribute it and/or modify it
+# sawfish is free software; you can redistribute it and/or modify it
 # under the terms of the GNU General Public License as published by
 # the Free Software Foundation; either version 2, or (at your option)
 # any later version.
 #
-# sawmill is distributed in the hope that it will be useful, but
+# sawfish is distributed in the hope that it will be useful, but
 # WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with sawmill; see the file COPYING.  If not, write to
+# along with sawfish; see the file COPYING.  If not, write to
 # the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
 include ./Makedefs
diff -u -r trunk/README.IMPORTANT mytrunk/README.IMPORTANT
--- trunk/README.IMPORTANT	2009-01-08 15:10:31.132310000 +0900
+++ mytrunk/README.IMPORTANT	2009-01-09 20:47:29.388340526 +0900
@@ -1,22 +1,16 @@
-In Sawfish 1.5.0 there are the following major changes:
+This file lists incompatible changes.
 
-**********
+* In Sawfish 1.5.0,
 
-- sawmill-defaults is now sawfish-defaults
+  - sawmill-defaults is now sawfish-defaults
 
-This means if you got
+    This means if you got
 
-(require 'sawmill-defaults) in your sawfishrc, replace it by
-(require 'sawfish-defaults)
+    (require 'sawmill-defaults) in your sawfishrc, replace it by
+    (require 'sawfish-defaults)
 
-**********
+  - ~/.sawmillrc is no longer a valid configuration file, if
+    you still use it, rename it to either ~/.sawfishrc or ~/sawfish/rc
 
-- ~/.sawmillrc is no longer a valid configuration file, if
-you still use it, rename it to either ~/.sawfishrc or ~/sawfish/rc
-
-**********
-
-- XFree86 is no longer detected by configure.in 
-(XXX Will add work-around for XFree86 Users later on XXX)
-
-**********
+  - XFree86 is no longer detected by configure.in 
+    (XXX Will add work-around for XFree86 Users later on XXX)
diff -u -r trunk/man/faq.texi mytrunk/man/faq.texi
--- trunk/man/faq.texi	2009-01-08 15:10:12.804299000 +0900
+++ mytrunk/man/faq.texi	2009-01-09 21:15:28.003348471 +0900
@@ -61,38 +61,32 @@
 
 @item How do I add customizations?
 
-There are several files controlling this:
+Three files are read in the startup, in the order: @file{sawfish-defaults}, 
+ file{~/.sawfish/custom}, @file{.sawfishrc}.
 
- table @file
- item ~/.sawfishrc
-Hand written lisp code, loaded at startup. This is where almost all
-explicit customization should be done.
+ table @asis
+ item @file{sawfish-defaults}
+This is a system default lisp library. It loads some of the common
+window manager features.
 
- item sawmill-defaults
-This lisp library is only loaded if there's no @file{.sawfishrc} file.
-
- item ~/.sawfish/custom
-This stores customizations created by the configuration tool; it
+ item @file{~/.sawfish/custom}
+This stores customizations created by the configurator GUI; it
 shouldn't really be edited manually.
 
-This file is loaded @emph{after} @file{sawmill-defaults}, but @emph{before}
- file{ sawfishrc} 
- end table
-
-
- item I created @file{.sawfishrc}, now things have changed?
-
-If a @file{~/.sawfishrc} file exists, it prevents
- file{sawmill-defaults} from being loaded. But it's
- file{sawmill-defaults} that loads some of the common window manager
-features, so add the line
+ item @file{~/.sawfishrc} or @file{~/.sawfish/rc} 
+This is the file you edit. It is a hand written lisp code. If @file{~/.sawfishrc}
+doesn't exist, then @file{~/.sawfish/rc} is read.
+
+If this file is present, then @file{sawfish-defaults} isn't read by default.
+But it loads standard features, so if you want it, add the following line 
+to your @file{.sawfishrc} file:
 
 @lisp
-(require 'sawmill-defaults)
+(require 'sawfish-defaults)
 @end lisp
 
- noindent to your @file{.sawfishrc} file if you want to start with all
-the standard features loaded.
+In fact, @file{sawfish-defaults} is an alias of @file{sawfish.wm.defaults}.
+ end table
 
 
 @item What's this @code{sawfish-client} program?
@@ -291,5 +285,7 @@
 will create associated files with @file{.jlc} suffixes containing the
 compiled Lisp code.
 
+Remember that always the latest code is read, i.e., if the source is 
+newer than the byte compiled file, the source is used, unlike emacs.
 
 @end enumerate