Simplify.
authorDaiki Ueno <ueno@unixuser.org>
Wed, 22 Apr 2009 07:02:43 +0000 (07:02 +0000)
committerDaiki Ueno <ueno@unixuser.org>
Wed, 22 Apr 2009 07:02:43 +0000 (07:02 +0000)
doc/HACKING
doc/HACKING.ja

index 22590f8..a9dc9d2 100644 (file)
@@ -1,23 +1,23 @@
 -*- mode: text -*-
 
 -*- mode: text -*-
 
-This document is for Riece developers.  The information necessary for
-Riece development is explained (i.e. its development process and the
-internals.)
+This document is for Riece developers or those who are interested in
+becoming a developer.  The main topic explained here is about
+development process and the internals.
 
 * Development process
 
 ** Bug report
 
 You can create a template of a bug report by clicking the "bug" button
 
 * Development process
 
 ** Bug report
 
 You can create a template of a bug report by clicking the "bug" button
-in a toolbar, or M-x riece-submit-bug-report.  It is necessary to set
-riece-debug to t before preparing a bug report.
+in a toolbar, or M-x riece-submit-bug-report.  You need to set
+riece-debug to t when preparing a bug report.
 
 ** Debug output
 
 
 ** Debug output
 
-If the riece-debug variable is set to t, Riece begins to collect
-debugging information in *Debug* buffer.  Interactions with IRC
-servers are stored in " *IRC*<IRC-server-name>" buffers.  Note that
-these buffers have names starting with a whitespace character (" ").
+If riece-debug is t, "*Debug*" buffer will have debugging information.
+Also, interactions with IRC servers will be written to "
+*IRC*<IRC-server-name>" buffers.  Note that these buffers have a name
+starting with a whitespace character (" ").
 
 ** Joining the development
 
 
 ** Joining the development
 
@@ -25,25 +25,21 @@ To join the development, send us a patch or an add-on.
 
 ** CVS
 
 
 ** CVS
 
-Development of Riece uses CVS.  Latest developing version is available
-at CVS.  Please note that the version from CVS may NOT be reliable,
-and you can only use it at your own risk.  We may ignore bug reports
-for that version.  The instruction to access the CVS server is below.
+The development of Riece uses CVS.  The latest development version is
+available from cvs.m17n.org.  The instructions to obtain and build the
+source from the CVS are below.
 
 
-(1) logging in to anonymous CVS server
-
-    cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
-    CVS password: [CR] # NULL string
-
-(2) checkout modules
+(1) checkout modules
 
     cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece
 
 
     cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece
 
-(3) generate configure script
+You can specify a tag in front of the module name.
+
+(2) generate configure script
 
     autoreconf -f -i -v
 
 
     autoreconf -f -i -v
 
-You will need newer version of GNU Automake.
+Note that "autoreconf" is not "autoconf".
 
 * Internals
 
 
 * Internals
 
index 4a492e8..78363fe 100644 (file)
@@ -28,23 +28,17 @@ M-x riece-submit-bug-report \e$B$G:n@.$7$F$/$@$5$$!#$^$?!"%P%0Js9p$N:n@.$N\e(B
 Riece \e$B$N3+H/$K$O\e(B CVS \e$B$rMxMQ$7$F$$$^$9!#8x3+\e(B CVS \e$B%5!<%P$+$i:G?7HG$N%=!<\e(B
 \e$B%9%3!<%I$r<hF@$9$k$K$O0J2<$N$h$&$K$7$^$9!#\e(B
 
 Riece \e$B$N3+H/$K$O\e(B CVS \e$B$rMxMQ$7$F$$$^$9!#8x3+\e(B CVS \e$B%5!<%P$+$i:G?7HG$N%=!<\e(B
 \e$B%9%3!<%I$r<hF@$9$k$K$O0J2<$N$h$&$K$7$^$9!#\e(B
 
-CVS \e$BHG$N%=!<%9%3!<%I$O!"$"$/$^$G3+H/ES>e$N$b$N$G$"$j!"MxMQ$O8D?M$N@UG$\e(B
-\e$B$G$*4j$$$7$^$9!#\e(BCVS \e$BHG$K4X$9$k%P%0Js9p$O<u$1IU$1$^$;$s!#\e(B
-
-(1) CVS \e$B%5!<%P$X$N%m%0%$%s\e(B
-
-    cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
-    CVS password: [CR] # NULL string
-
-(2) \e$B%b%8%e!<%k$N%A%'%C%/%"%&%H\e(B
+(1) \e$B%b%8%e!<%k$N%A%'%C%/%"%&%H\e(B
 
     cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece
 
 
     cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece
 
-(3) configure \e$B%9%/%j%W%H$N@8@.\e(B
+\e$B%b%8%e!<%kL>$NA0$K%?%0$r;XDj$G$-$^$9!#\e(B
+
+(2) configure \e$B%9%/%j%W%H$N@8@.\e(B
 
     autoreconf -f -i -v
 
 
     autoreconf -f -i -v
 
-\e$B$3$N:n6H$K$O:G?7$N\e(B GNU Automake \e$B$,I,MW$+$b$7$l$^$;$s!#\e(B
+"autoreconf" \e$B$O\e(B "autoconf" \e$B$G$O$J$$$3$H$KCm0U$7$F$/$@$5$$!#\e(B
 
 * \e$BFbIt9=B$\e(B
 
 
 * \e$BFbIt9=B$\e(B
 
@@ -418,4 +412,4 @@ riece-after-privmsg-hook \e$B$NFs$D$N%U%C%/$,8F$P$l$^$9!#\e(B
 \e$B$P!"$=$N8e$N=hM}$r$*$3$J$$$^$;$s!#$^$?!"$=$N>l9g$K$O\e(B
 riece-after-<message>-hook \e$B$b8F$S=P$5$l$^$;$s!#\e(B
 
 \e$B$P!"$=$N8e$N=hM}$r$*$3$J$$$^$;$s!#$^$?!"$=$N>l9g$K$O\e(B
 riece-after-<message>-hook \e$B$b8F$S=P$5$l$^$;$s!#\e(B
 
-\e$B%U%C%/$N0z?t$K$O\e(B RFC2812 \e$B$N\e(B prefix \e$B$H\e(B parameters \e$B$,EO$j$^$9!#\e(B
\ No newline at end of file
+\e$B%U%C%/$N0z?t$K$O\e(B RFC2812 \e$B$N\e(B prefix \e$B$H\e(B parameters \e$B$,EO$j$^$9!#\e(B