[DRBD-cvs] drbd by lars; Adding INSTALL to 0.7 branch, improving ...

[drbd-user@lists.linbit.com]

DRBD CVS committal

Author  : lars
Module  : drbd

Dir     : drbd


Modified Files:
      Tag: rel-0_7-branch
	README Makefile 
Added Files:
      Tag: rel-0_7-branch
	INSTALL 


Log Message:
Adding INSTALL to 0.7 branch, improving README

===================================================================
RCS file: /var/lib/cvs/drbd/drbd/README,v
retrieving revision 1.7.2.2
retrieving revision 1.7.2.3
diff -u -3 -r1.7.2.2 -r1.7.2.3
--- README	5 Jan 2004 10:06:48 -0000	1.7.2.2
+++ README	26 Apr 2004 09:32:46 -0000	1.7.2.3
@@ -7,17 +7,44 @@
 Unfortunately my time does not allow me to maintain this README besides
 the software. 
 
-Please refer to the web page 
-http://www.complang.tuwien.ac.at/reisner/drbd
+Please refer to the web pages at
+http://www.drbd.org/
 to find maintained information.
 
 Reference documentation is included in the documentation directory.
+Please have a look at INSTALL or INSTALL.html, too.
+BTW, if there is no INSTALL.html, say "make INSTALL.html" :)
 
 
 DEBUGING:
 
 In case you experience kernel crashes when using DRBD, please
-recompile DRBD and set the DEBUGFLAGS in Makefile.vars to -DDEBUG.
+define "DBG_ALL_SYMBOLS" in drbd_config.h, and recompile DRBD.
 
-Run the oops through ksyms and send it to the DRBD mailinglist.
+Run the oops through ksymoops and send it to the DRBD mailinglist.
+If you don't know what ksymoops is, read
+/usr/src/linux/Documentation/oops-tracing.txt
 
+BUILD RPMS:
+
+It should be enough to just say: make rpm.
+If not, you probably need to add some packages,
+or edit the drbd.spec(.in) file.
+
+After make rpm there should be distributable rpms in dist/*/*/drbd-*.*.rpm
+
+REDHAT USERS:
+
+Have a look into drbd_config.h, and uncomment the RH-specific defines.
+
+If you do not run a selfcompiled kernel, but the binary shipped
+distro kernel, and after "make install" the drbd module ends up in
+the wrong place (e.g. /lib/modules/2.4.20custom/, when you want it
+in /lib/modules/2.4.20/), edit the top-level Makefile of your
+kernel source tree and remove "custom" from the EXTRAVERSION.
+Make sure you copied in the .config corresponding to the kernel you use.
+Don't forget to "make dep" in /usr/src/linux, it sometimes helps, too.
+
+(you could of course edit .kernelversion in the drbd directory,
+ or copy by hand, too)
+ 
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/Makefile,v
retrieving revision 1.11.2.15
retrieving revision 1.11.2.16
diff -u -3 -r1.11.2.15 -r1.11.2.16
--- Makefile	20 Apr 2004 16:16:50 -0000	1.11.2.15
+++ Makefile	26 Apr 2004 09:32:46 -0000	1.11.2.16
@@ -43,6 +43,9 @@
 install:
 	@ set -e; for i in $(SUBDIRS); do $(MAKE) -C $$i install; done
 
+install-tools:
+	@ set -e; for i in $(patsubst drbd,,$(SUBDIRS)); do $(MAKE) -C $$i install; done
+
 clean:
 	@ set -e; for i in $(SUBDIRS); do $(MAKE) -C $$i clean; done
 	rm -f *~
@@ -136,3 +139,26 @@
 	    --define "kdir $(KDIR)" \
 	    $(PWD)/dist/SPECS/drbd.spec
 	@echo "You have now:" ; ls -l dist/*RPMS/*/*.rpm
+
+
+# the INSTALL file is writen in lge-markup, which is basically
+# wiki style plus some "conventions" :)
+# why don't I write in or convert to HTML directly?
+# editing INSTALL feels more natural this way ...
+
+INSTALL.html: INSTALL.pod
+	-pod2html --title "Howto Build and Install DRBD" \
+		< INSTALL.pod > INSTALL.html ; rm -f pod2htm*
+#	-w3m -T text/html -dump < INSTALL.html > INSTALL.txt
+
+INSTALL.pod: INSTALL
+	-@perl -pe 'BEGIN { print "=pod\n\n"; };                  \
+	 	s/^= +(.*?) +=$$/=head1 $$1/;                     \
+	 	s/^== +(.*?) +==$$/=head2 $$1/;                   \
+		s/^(Last modi)/ $$1/ and next;                    \
+	 	if(s/^ +([^#]*)$$/$$1/ or /^\S/) {                \
+			s/(Note:)/B<$$1>/g;                       \
+			s/"([^"]+)"/C<$$1>/g;                     \
+	 		s,((^|[. ])/(`[^`]*`|\S)+),C<$$1>,g;      \
+	 	}' \
+	 	< INSTALL > INSTALL.pod