[Csync2] Underdocumented -N option

[Andreas J. Koenig]

>>>>> On Thu, 13 Apr 2006 13:36:05 +0200, Clifford Wolf <clifford at clifford.at> said:

  > Hi,
  > On Thu, Apr 13, 2006 at 04:28:17AM +0200, Andreas J. Koenig wrote:
 >> While peeking into the source I discovered the wonderful option -N
 >> that had always escaped my attention in the paper.pdf. I'd like to
 >> offer a few words to be added to the paper.pdf:
 >> 
 >> [ Add doc for -N option ]

  > I've added a short description of the -N option to the paper now. But I've
  > used a different text: basically because you speak of 'fully qualified
  > names' and 'the receiving end' in your suggestion which are imo confusing
  > limitations to what -N does (which is in fact very simple).

Wonderful, thanks much (no, I don't feel offended by superior patches:)

 >> BTW, what are your plans about the paper.pdf? Are there obstacles that
 >> prevent you from releasing its source within the release tarball? It's
 >> often inconvenient if there is just a PDF file as documentation...

  > The LaTeX source of the paper is managed in a seperate subversion
  > repository (a repository with my papers and presentations). The source can
  > be downloaded from:

  > 	http://www.clifford.at/papers/2005/csync2/

Great, thanks! I'm not a good detective, I usually do not visit the
directory of an URL that an author provides. How could I have known
that there is access to source code?

  > (but it needs the bit exotic TeX 'svn' package)

  > adding the TeX source to the csync2 package would be code duplication. And
  > I don't like code duplication very much..  ;-)

;)

  > adding the PDF would be ok. but I liked the idea of beeing able to extend
  > the documentation without the need of making a new release for publishing
  > the updated documentation.. and I do not think that it is very likely that
  > someone is going to setup csync2 on a cluster but has no access to the
  > internet.

It's not about having access to the internet or not, it's about having
access to the source and about NOT having access to a PDF viewer. Some
people among your users might consider PDF an inferior format to ASCII
text, I'm sure. Now we know where the source is. I'd suggest a patch
to the README:

--- README.bak	2006-04-13 21:34:47.000000000 +0200
+++ README	2006-04-13 21:36:06.000000000 +0200
@@ -48,8 +48,9 @@
 
 	http://oss.linbit.com/csync2/paper.pdf
 
-You should definitely read the documentation before trying to setup csync2.
-
+You should definitely read the documentation before trying to setup
+csync2. If you prefer to read a text version of the documentation,
+feel free to download http://www.clifford.at/papers/2005/csync2/paper.tex
 
 More Documentation
 ==================


__EOPATCH__


As always, please amend my patch to your needs, I'm not trying to push
something, I'm just suggesting. Please understand that there are
situations where all you have is a text console and these sometimes
are the situations when you need documentation more than ever.

Greetings,
-- 
andreas