From: Ian Silvester <iansilvester@fastmail.fm>
Date: Sun, 18 Mar 2012 01:16:35 +0000 (+0000)
Subject: Brought OS X section up to date, deprecating the osxsetup module and adding a section... 
X-Git-Tag: v_3_0_20~382
X-Git-Url: http://www.privoxy.org/gitweb/contact.html?a=commitdiff_plain;h=e4e049244bdb5a80ed96f371d71956ee4422468f;p=privoxy.git

Brought OS X section up to date, deprecating the osxsetup module and adding a section referring to the OSXPackageBuilder module
---

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index 70f4d3ba..49cafa43 100644
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -24,7 +24,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: developer-manual.sgml,v 2.37 2011/11/13 17:03:54 fabiankeil Exp $
+ $Id: developer-manual.sgml,v 2.38 2011/12/26 17:05:40 fabiankeil Exp $
 
  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
@@ -51,7 +51,7 @@
     </pubdate>
 
 
-    <pubdate>$Id: developer-manual.sgml,v 2.37 2011/11/13 17:03:54 fabiankeil Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 2.38 2011/12/26 17:05:40 fabiankeil Exp $</pubdate>
 
 <!--
 
@@ -2657,47 +2657,106 @@ at sourceforge. Three simple steps:
 
     <sect3 id="newrelease-macosx"><title>Mac OS X</title>
       <para>
-	First, <emphasis>make sure that you have freshly exported the right
+        First, <emphasis>make sure that you have freshly exported the right
         version into an empty directory</emphasis>. (See "Building and releasing
-        packages" above). Then get the Mac OS X setup module:
-	</para>
-	<para>
-	<programlisting>
+        packages" above).
+      </para>
+      <para>
+        There are three modules available in the CVS repository for use on Mac
+        OS X, though technically only two of them generate a release (the other
+        can be used to install from source).
+      </para>
+      <sect4 id="OS-X-OSXPackageBuilder-module">
+      <title>OSXPackageBuilder module</title>
+        <para>
+          The OSXPackageBuilder module generates OS X installer packages
+          supporting all Macs running OS X 10.4 and above. Obtain it from CVS as
+          follows into a folder parallel to the exported privoxy source:
+          <programlisting>
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder
+</programlisting>
+        </para>
+        <para>
+          The module contains complete instructions on its usage in the file
+          <filename>OS X Package Builder HOWTO.txt</filename>.
+        </para>
+        <para>
+          Once the package(s) have been generated, you can then upload them
+          directly to the Files section of the Sourceforge project in the
+          Macintosh (OS X) folder. Each new version release of Privoxy should
+          have a new subfolder created in which to store its files. Please
+          ensure that the folder contains a readme file that makes it clear
+          which package is for whichversion of OS X.
+        </para>
+      </sect4>
+      <sect4 id="OS-X-osxsetup-module">
+      <title>osxsetup module (DEPRECATED)</title>
+        <para>
+          <emphasis>This module is deprecated since the installer it generates
+          places all Privoxy files in one folder in a non-standard location, and
+          supports only Intel Macs running OS X 10.6 or higher.</emphasis>
+        </para>
+        <para>
+          Check out the module from CVS as follows into a folder parallel to the
+          exported privoxy source:
+          <programlisting>
   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
 </programlisting>
-	</para>
-	<para>
-	Then run:
-	</para>
-	<para>
-	<programlisting>
+        </para>
+        <para>
+          Then run:
+        </para>
+        <para>
+          <programlisting>
   cd osxsetup
   build
 </programlisting>
-	</para>
-	<para>
-	This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
-	<filename>configure</filename> as well as <filename>make</filename>.
-	Finally, it will copy over the necessary files to the ./osxsetup/files directory
-	for further processing by <filename>PackageMaker</filename>.
-	</para>
-	<para>
-	Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
-	name to match the release, and hit the "Create package" button.
-	If you specify ./Privoxy.pkg as the output package name, you can then create
-	the distributable zip file with the command:
-	</para>
-	<para>
-	<programlisting>
+        </para>
+        <para>
+          This will run <filename>autoheader</filename>, <filename>autoconf</filename>
+          and <filename>configure</filename> as well as <filename>make</filename>.
+          Finally, it will copy over the necessary files to the ./osxsetup/files
+          directory for further processing by <filename>PackageMaker</filename>.
+        </para>
+        <para>
+        Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
+        modify the package name to match the release, and hit the "Create
+        package" button. If you specify ./Privoxy.pkg as the output package
+        name, you can then create the distributable zip file with the command:
+        </para>
+        <para>
+          <programlisting>
   zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
 </programlisting>
-	</para>
-	<para>
-	You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
-	<filename>uploads.sourceforge.net/incoming</filename>,
-	create a release for it, and you're done. Use the release notes
-        and Change Log from the source tarball package.
-	</para>
+        </para>
+        <para>
+          You can then upload this file directly to the Files section of the
+          Sourceforge project in the Macintosh (OS X) folder. Each new version
+          release of Privoxy should have a new subfolder created in which to
+          store its files.
+          Please ensure that the folder contains a readme file that makes it
+          clear which version(s) of OS X the package supports.
+        </para>
+      </sect4>
+      <sect4 id="OS-X-macsetup-module">
+      <title>macsetup module</title>
+        <para>
+          The macsetup module is ideal if you wish to build and install Privoxy
+          from source on a single machine.
+        </para>
+        <para>
+          Check out the module from CVS as follows into a folder parallel to the
+          exported privoxy source:
+          <programlisting>
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup
+</programlisting>
+        </para>
+        <para>
+          The module contains complete instructions on its usage in its
+          <filename>README</filename> file. The end result will be the the
+          exported version of Privoxy installed on the build machine.
+        </para>
+      </sect4>
     </sect3>
 
     <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
@@ -3005,6 +3064,9 @@ at sourceforge. Three simple steps:
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $
+  Revision 2.38  2011/12/26 17:05:40  fabiankeil
+  Bump entities for 3.0.19
+
   Revision 2.37  2011/11/13 17:03:54  fabiankeil
   Bump entities for 3.0.18 stable