Convert documentation and README do asciidoc

lge · lge · commit b9749215a9cd · 2018-11-15T16:42:13.000+01:00
... and place symlinks to avoid arguing with automake :-/
diff --git a/AUTHORS b/AUTHORS
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1 @@
+AUTHORS.adoc
diff --git a/AUTHORS.adoc b/AUTHORS.adoc
@@ -0,0 +1,17 @@
+Copyright © 2004 - 2013  LINBIT Information Technologies GmbH +
+Copyright © 2008 - 2018  https://www.linbit.com[LINBIT HA Solutions GmbH]
+
+Original csync2 author, no longer involved with the project:
+    2004, 2005  Clifford Wolf
+
+Most development 1.34 to 2.0:
+    2010  Johannes Thoma
+
+Coordination, fixes and maintenance, ongoing:
+    Lars Ellenberg <lars@linbit.com>
+
+Major contributions:
+    2010  Dennis Schafroth,
+    2008  Art -kwaak- van Breemen
+
+And others; for details see the git log.
diff --git a/ChangeLog b/ChangeLog
@@ -1,5 +1,5 @@
 Please see git for a complete changelog:
-http://git.linbit.com/csync2.git/
+https://github.com/LINBIT/csync2/
 
-git clone git://git.linbit.com/csync2.git
+git clone https://github.com/LINBIT/csync2/
 cd csync2 && git log
diff --git a/Makefile.am b/Makefile.am
@@ -27,7 +27,7 @@ csync2_SOURCES = action.c cfgfile_parser.y cfgfile_scanner.l check.c	\
 		 db_api.c db_sqlite.c db_sqlite2.c db_mysql.c db_postgres.c \
 		 csync2.h db_api.h db_mysql.h db_postgres.h db_sqlite.h db_sqlite2.h dl.h \
 		 csync2-compare \
-		 csync2.1 doc/csync2_paper.tex \
+		 csync2.1 \
 		 csync2.spec
 
 EXTRA_DIST = csync2.cfg csync2.xinetd
@@ -40,24 +40,7 @@ CLEANFILES = cfgfile_parser.c cfgfile_parser.h cfgfile_scanner.c	\
 
 DISTCLEANFILES = config.status config.h .deps/*.Po stamp-h1 Makefile Makefile.in configure
 
-docfiles = ChangeLog README AUTHORS
-
-if HAVE_PDFLATEX
-
-MANNAME = doc/csync2_paper
-MANTEXSRC = $(MANNAME).tex
-MANAUX = $(MANNAME).aux
-MANPDF = $(MANNAME).pdf
-
-docfiles += $(MANPDF)
-
-CLEANFILES += $(MANPDF) $(MANAUX) $(MANNAME).log $(MANNAME).idx $(MANNAME).out $(MANNAME).toc
-
-$(MANPDF): $(MANTEXSRC)
-	$(PDFLATEX) -interaction=batchmode -output-directory doc $< >/dev/null
-	$(PDFLATEX) -interaction=batchmode -output-directory doc $< >/dev/null
-
-endif
+docfiles = ChangeLog README.adoc AUTHORS.adoc doc/csync2.adoc
 
 doc_DATA = $(docfiles)
 dist_doc_DATA = $(docfiles)
diff --git a/README b/README
diff --git a/README b/README
@@ -0,0 +1 @@
+README.adoc
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,43 @@
+
+About csync2
+------------
+
+Csync2 is a cluster synchronization tool. It can be used to keep files on
+multiple hosts in a cluster in sync. Csync2 can handle complex setups with
+much more than just 2 hosts, handle file deletions and can detect conflicts.
+
+It is expedient for HA-clusters, HPC-clusters, COWs and server farms. If
+you are looking for a tool to sync your laptop with your workstation, you
+better have a look at Unison (http://www.cis.upenn.edu/~bcpierce/unison/)
+too.
+
+The csync2 git tree can be found at https://github.com/LINBIT/csync2/.
+
+Copyright
+---------
+
+csync2 - cluster synchronization tool, 2nd generation +
+Copyright © 2004 - 2013  LINBIT Information Technologies GmbH +
+Copyright © 2008 - 2018  https://www.linbit.com[LINBIT HA Solutions GmbH] +
+see also <<AUTHORS#,AUTHORS>>
+
+License
+-------
+SPDX-License-Identifier: GPL-2.0-or-later
+
+Documentation
+-------------
+
+You should definitely read the documentation before trying to setup csync2, +
+see <<doc/csync2#>>
+
+Mailing List
+------------
+
+There is a csync2 mailing list:
+
+http://lists.linbit.com/mailman/listinfo/csync2
+
+It is recommended to subscribe to this list if you are using csync2 in
+production environments.
+
diff --git a/csync2.c b/csync2.c
@@ -100,9 +100,10 @@ void help(char *cmd)
 	printf(
 "\n"
 PACKAGE_STRING " - cluster synchronization tool, 2nd generation\n"
-"Copyright (C) 2004 - 2015 LINBIT Information Technologies GmbH\n"
-"        http://www.linbit.com\n"
-"See also: http://git.linbit.com/csync2.git/?a=blob;f=AUTHORS\n"
+"Copyright (C) 2004 - 2013  LINBIT Information Technologies GmbH\n"
+"Copyright (C) 2008 - 2018  LINBIT HA Solutions GmbH\n"
+"        https://www.linbit.com\n"
+"See also: https://github.com/LINBIT/csync2/\n"
 "\n"
 "Version: " CSYNC2_VERSION "\n"
 "\n"
diff --git a/csync2.spec b/csync2.spec
@@ -63,7 +63,7 @@ mkdir -p $RPM_BUILD_ROOT%{_sysconfdir}/xinetd.d
 %makeinstall
 
 install -m 644 csync2.xinetd $RPM_BUILD_ROOT%{_sysconfdir}/xinetd.d/csync2
-install -m 644 doc/csync2_paper.pdf $RPM_BUILD_ROOT%{_docdir}/csync2/csync2_paper.pdf
+install -m 644 doc/csync2.adoc $RPM_BUILD_ROOT%{_docdir}/csync2/csync2.adoc
 
 %clean
 [ "$RPM_BUILD_ROOT" != "/" ] && [ -d $RPM_BUILD_ROOT ] && rm -rf $RPM_BUILD_ROOT
@@ -80,7 +80,7 @@ fi
 %{_sbindir}/csync2-compare
 %{_var}/lib/csync2
 %doc %{_mandir}/man1/csync2.1.gz
-%doc %{_docdir}/csync2/csync2_paper.pdf
+%doc %{_docdir}/csync2/csync2.adoc
 %doc %{_docdir}/csync2/ChangeLog
 %doc %{_docdir}/csync2/README
 %doc %{_docdir}/csync2/AUTHORS
diff --git a/debian/docs b/debian/docs
@@ -1 +1,3 @@
-README
+README.adoc
+AUTHORS.adoc
+doc/csync2.adoc
diff --git a/doc/csync2.adoc b/doc/csync2.adoc
diff --git a/doc/csync2_paper.tex b/doc/csync2_paper.tex

-Original file line number
+Diff line change
@@ @@ -1,5 +1,5 @@ @@
 Please see git for a complete changelog:
 -http://git.linbit.com/csync2.git/
 +https://github.com/LINBIT/csync2/
 -git clone git://git.linbit.com/csync2.git
 +git clone https://github.com/LINBIT/csync2/
 cd csync2 && git log