Developer manual: Optimize Debian build instructions.
[privoxy.git] / doc / source / developer-manual.sgml
index 5768b30..8f8c3a7 100644 (file)
@@ -19,7 +19,7 @@
 
  Purpose     :  developer manual
 
- Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
@@ -39,7 +39,7 @@
     <!-- Completely the wrong markup, but very little is allowed  -->
     <!-- in this part of an article. FIXME -->
       <ulink url="https://www.privoxy.org/user-manual/copyright.html">Copyright</ulink>
-      &my-copy; 2001-2020 by
+      &my-copy; 2001-2021 by
       <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
      </subscript>
     </pubdate>
@@ -2060,7 +2060,8 @@ fk@t520 ~ $privoxy-regression-test.pl --test-number 785 --verbose --debug 4
      </programlisting>
      <para>
       Use the if the <command>--privoxy-address</command> option if the
-      http_proxy environment variable isn't configured.
+      http_proxy environment variable isn't configured and you don't want
+      to use the default (http://127.0.0.1:8118/).
      </para>
     </sect2>
 
@@ -2619,26 +2620,171 @@ for-privoxy-version=3.0.11
 
     <sect3 id="newrelease-debian"><title>Debian</title>
       <para>
-        First, <emphasis>make sure that you have freshly exported the
-        right version into an empty directory</emphasis>. (See
-        "Building and releasing packages" above).  Then add a log
-        entry to <filename>debian/changelog</filename>, if it is not
-        already there, for example by running:
+       Using git-buildpackage we start with a clone of the last Debian version:
       </para>
-        <programlisting>
-  debchange -v &p-version;-&p-status;-1 "New upstream version"
+      <programlisting>
+  gbp clone https://salsa.debian.org/debian/privoxy.git
+  cd privoxy
 </programlisting>
       <para>
-        Then, run:
+       or if the repository is already there
       </para>
-        <programlisting>
-  dpkg-buildpackage -rfakeroot -us -uc -b
+      <programlisting>
+  cd privoxy
+  gbp pull
 </programlisting>
       <para>
-        This will create
-        <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
-        which can be uploaded.
+       Now import the newly released upstream tarball via debian/watch file:
       </para>
+      <programlisting>
+  gbp import-orig --uscan
+</programlisting>
+      <para>
+       Next update all Debian quilt patches to the new version:
+      </para>
+      <programlisting>
+  while quilt push; do quilt refresh; done
+</programlisting>
+      <para>
+       If some patch is no longer required (because it is already merged
+       upstream), it can be removed using
+      </para>
+      <programlisting>
+  quilt delete XX_patchname.patch
+  git rm debian/patches/XX_patchname.patch
+</programlisting>
+      <para>
+       If the patch needs modification, you can apply, edit and update it with
+      </para>
+      <programlisting>
+  quilt push -f
+  quilt edit some_file
+  quilt refresh
+</programlisting>
+      <para>
+       until
+      </para>
+      <programlisting>
+  while quilt push; do quilt refresh; done
+</programlisting>
+      <para>
+       succeeds. Then you can
+      </para>
+      <programlisting>
+  quilt pop -a
+</programlisting>
+      <para>
+       Now add a new entry to the debian/changelog representing the new
+       version:
+      </para>
+      <programlisting>
+  dch -v &p-version;-1
+</programlisting>
+      <para>
+       and describe what you did before and don't forget to git commit all
+       changes.
+      </para>
+      <para>
+       Now you can build the package on the local machine using
+      </para>
+      <programlisting>
+  gbp buildpackage -us -uc
+</programlisting>
+      <para>
+       You should check for warnings using
+      </para>
+      <programlisting>
+  lintian -iI ../build-area/privoxy_&p-version;-1_amd64.changes
+</programlisting>
+      <para>
+       Maybe rebuild the package in different defined cowbuilder environments
+       like
+      </para>
+      <programlisting>
+  sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_&p-version;-1.dsc
+</programlisting>
+      <para>
+       And try to run autopackage testing suite on the result:
+      </para>
+      <programlisting>
+  autopkgtest /var/cache/pbuilder/result/privoxy_&p-version;-1_amd64.changes -s -- schroot sid
+</programlisting>
+      <para>
+       Or just push the changes to salsa.debian.org, where a CI pipeline is
+       defined for the package, that builds and tests it.
+      </para>
+      <para>
+       If everything is okay, run cowbuilder with i386 and amd64 environments
+       for current Debian stable release and build
+       privoxy_&p-version;-1_i386.deb and privoxy_&p-version;-1_amd64.deb.
+       Then sign both files:
+      </para>
+      <programlisting>
+  gpg --detach-sign --armor privoxy_&p-version;-1_i386.deb
+  gpg --detach-sign --armor privoxy_&p-version;-1_amd64.deb
+</programlisting>
+      <para>
+       Create a README file containing the recent block from debian/changelog
+       and upload the two packages, the two signatures and the README to a
+       freshly created folder below
+       https://sourceforge.net/projects/ijbswa/files/Debian/
+      </para>
+
+      <sect4 id="snapshot-debian"><title>Debian GIT Snapshot</title>
+      <para>
+       For building just a git snapshot build the following workflow may be
+       useful.  First create a build environment, for this you may have to
+       run the following commands:
+      </para>
+      <programlisting>
+  sudo apt install build-essential devscripts
+  sudo apt-get build-dep privoxy
+</programlisting>
+      <para>
+       After this enter the checked out privoxy git tree and check that all
+       (new) build dependencies are met:
+      </para>
+      <programlisting>
+  dpkg-checkbuilddeps
+</programlisting>
+      <para>
+       If something is missing, just add it using
+      </para>
+      <programlisting>
+  sudo apt install foobar
+</programlisting>
+      <para>
+       Now you may update debian/changelog, especially the version number
+       using
+      </para>
+      <programlisting>
+  dch
+</programlisting>
+      <para>
+       and finally build the package:
+      </para>
+      <programlisting>
+  debuild -us -uc -b
+</programlisting>
+      <para>
+       If everything went okay, you may find the resulting Debian package in
+       the parent directory.
+      </para>
+      <para>
+       You may want to clean up the build tree using
+      </para>
+      <programlisting>
+  debian/rules clean
+</programlisting>
+      <para>
+       And maybe repair some artefacts using one or both of the following
+       commands:
+      </para>
+      <programlisting>
+  git reset --hard
+  git clean -fd
+</programlisting>
+    </sect4>
     </sect3>
 
     <sect3 id="newrelease-macosx"><title>Mac OS X</title>