From c3046b60809164789797c818b43031e7d9d3a02e Mon Sep 17 00:00:00 2001
From: Chris Frey <cdfrey@foursquare.net>
Date: Wed, 4 Jun 2008 17:13:38 -0400
Subject: [PATCH] Documentation updates: git, tarball, bugs, contact

- changed git patch command to use format-patch
- added instructions for building from tarball
- added bugs.php and contact.php pages
---
 ChangeLog            |  4 ++++
 doc/www/bugs.php     | 29 +++++++++++++++++++++++++++++
 doc/www/contact.php  | 25 +++++++++++++++++++++++++
 doc/www/content_list |  2 ++
 doc/www/cvs.php      | 29 ++++++++++++++++++++++++++++-
 doc/www/index.php    |  2 +-
 doc/www/patches.php  |  8 +++++---
 7 files changed, 94 insertions(+), 5 deletions(-)
 create mode 100644 doc/www/bugs.php
 create mode 100644 doc/www/contact.php

diff --git a/ChangeLog b/ChangeLog
index 6ca93df7..7c28fca7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,10 @@ Release: version 0.13 - 2008/06/??
 ------------------------------------------------------------------------------
 2008/06/04
 	- added notes to web documentation for OpenBSD
+	- documentation updates:
+		- changed git patch command to use format-patch
+		- added instructions for building from tarball
+		- added bugs.php and contact.php pages
 2008/05/30
 	- added Ubuntu 8.04 to release build scripts
 2008/05/29
diff --git a/doc/www/bugs.php b/doc/www/bugs.php
new file mode 100644
index 00000000..3637f62f
--- /dev/null
+++ b/doc/www/bugs.php
@@ -0,0 +1,29 @@
+<? createHeader("Reporting a Bug"); ?>
+
+<? include ("barry.inc"); ?>
+
+
+<div class="subHeader">Information to Report</div>
+
+<p>When reporting a bug, it is helpful to include as much information as you
+can about your system, and the circumstances surrounding the bug.</p>
+
+<p>
+Information to include, if applicable:
+<ul>
+	<li>The exact error message you get, if any, when you encounter
+		the problem</li>
+	<li>Version of Barry</li>
+	<li>How you installed Barry</li>
+	<li>Any sample data that may help in reproducing the problem</li>
+	<li>Name and version of your operating system</li>
+	<li>Architecture of your system (32 bit? 64 bit? Intel? iMac?)</li>
+</ul>
+</p>
+
+<p>Once you have all this information,
+<?createLink("contact", "send it to us"); ?>.</p>
+
+<p>If you also have a patch that solves the problem, see the page on
+<? createLink("patches", "submitting patches"); ?>.</p>
+
diff --git a/doc/www/contact.php b/doc/www/contact.php
new file mode 100644
index 00000000..83e7f1c7
--- /dev/null
+++ b/doc/www/contact.php
@@ -0,0 +1,25 @@
+<? createHeader("Contacting the Developers"); ?>
+
+<? include ("barry.inc"); ?>
+
+
+<div class="subHeader">Email</div>
+
+<p>The <b><i>best</i></b> way to reach the Barry developers is through the
+<a href="http://sourceforge.net/mail/?group_id=153722">barry-devel mailing list</a>.
+Subscribe and then post your query or comment.  This is the best
+place for sending patches, reporting bugs, or asking for support.</p>
+
+<p>If you need to contact Chris Frey, Barry's lead developer, privately,
+you can send email to cdfrey @ foursquare . net.  Mention the name and
+the version of the Barry package you are using when contacting Chris
+directly.</p>
+
+
+<div class="subHeader">Web</div>
+
+<p>If you cannot use email for some reason, you can also post support
+requests and bug reports on the Sourceforge
+<a href="http://sourceforge.net/tracker/?group_id=153722">tracker page</a>.
+</p>
+
diff --git a/doc/www/content_list b/doc/www/content_list
index 2c3d19c5..ddb1bd06 100644
--- a/doc/www/content_list
+++ b/doc/www/content_list
@@ -10,4 +10,6 @@ patches
 codingguide
 backups
 modem
+contact
+bugs
 
diff --git a/doc/www/cvs.php b/doc/www/cvs.php
index b172015d..aaebb16f 100644
--- a/doc/www/cvs.php
+++ b/doc/www/cvs.php
@@ -23,6 +23,33 @@ detailed information on the software that Barry needs.</p>
 </p>
 
 
+<div class="subHeader">Using The Tarball Release</div>
+
+<p>There are multiple source packages available on the Sourceforge download page.
+The main tarball is always the tar.bz2 package.  This contains everything in
+CVS, including pre-built configure scripts and website documentation.</p>
+
+<p>As an alternative, the tar.gz packages are Debian-specific.  This comes as
+an "orig" tarball, with the debian/ subdirectory contained in the diff.gz file.
+A .dsc file is included as well, for ease of Debian package building.  These
+files can be expanded into a Debian style source tree with the following
+command, for example:
+<pre>
+	dpkg-source -x barry_0.13-1.dsc
+</pre>
+</p>
+
+<p>Once the tar.gz and diff.gz files are combined, you will have a tree
+identical to what comes with the tar.bz2 package.</p>
+
+<p>See <i>Building the Source</i> below for instructions on building the
+resulting tree.</p>
+
+<p>Finally, there are rpm source packages, in the form of src.rpm files.
+This can be installed and built as usual, using the rpm and rpmbuild
+commands.</p>
+
+
 <div class="subHeader">Using CVS</div>
 
 <p>Up to date instructions for connecting to Sourceforge CVS repositories
@@ -188,7 +215,7 @@ steps for building RPMs from CVS:</p>
 </pre>
 
 
-<div class="subHeader">Building Barry DEBs from CVS</div>
+<div class="subHeader">Building Barry DEBs from Source</div>
 
 <p>Once you have ./configure generated as detailed above, you can
 create Debian-style binary packages for your system by running the
diff --git a/doc/www/index.php b/doc/www/index.php
index 8fe0fed4..eb539f5e 100644
--- a/doc/www/index.php
+++ b/doc/www/index.php
@@ -46,7 +46,7 @@ usefulness.  For example, it is possible to:
 <p>How do I...
 <ul>
 	<li><? createLink("install", "Install Barry from binary packages"); ?></li>
-	<li><? createLink("cvs", "Install Barry from CVS or git"); ?></li>
+	<li><? createLink("cvs", "Compile Barry from tarball, CVS, or git"); ?></li>
 	<li><? createLink("backups", "Make backups of my Blackberry data"); ?></li>
 	<li><? createLink("sync", "Sync my Blackberry with Evolution"); ?></li>
 	<li><? createLink("modem", "Use my Blackberry as a modem to surf the net"); ?></li>
diff --git a/doc/www/patches.php b/doc/www/patches.php
index 1a94f400..8a1ffc17 100644
--- a/doc/www/patches.php
+++ b/doc/www/patches.php
@@ -51,12 +51,14 @@ for submission:
 		way to add files without write access to the repository.
 		<br/><br/></li>
 
-	<li>If you are using the normal git tree, you can make your changes
-		in your own branch, and then:
+	<li>If you are using the git tree, you can make your changes
+		in your own branch, and then create patches for each
+		commit you've made:
 <pre>
 	cd barry-git
-	git diff origin/master..mybranch > patchfile
+	git format-patch origin/master
 </pre>
+
 	</li>
 
 </ul>
-- 
2.11.4.GIT