README_PATCHES.txt

   1 Patches Information
   2 ===================
   3
   4 The various patches, enhancements and downright replacements used to build
   5 the version of Git and supplementary software included in the Git OS X
   6 Installer are collected here.
   7
   8 For the files/patches included herein, some have explicit licenses embedded
   9 within them (typically GPLv2).  For the ones that do not explicitly mention
  10 a license the standard Git license applies -- this is especially true for
  11 any 'Signed-off-by' patches taken from the Git mailing list.  The standard
  12 Git license is GPLv2 ONLY.
  13
  14 Other files that do not have an explicit license and did not come from the
  15 Git mailing list are my own code and where the source file does not say
  16 otherwise are licensed under GPLv2 or, at your option, any later version.
  17
  18
  19 Git Patches
  20 -----------
  21
  22 * Use Mac OS X native API to show language translations
  23
  24   - `src/build-prefix.h`
  25   - `src/gettext.c`
  26   - `src/gettext-util.c`
  27   - `patches/git-sh-i18n-sh-git_gettext.diff`
  28   - `patches/git-gettext-failures.diff`
  29
  30 * Use libcurl for imap send
  31
  32   - `patches/km/git-imap-send_use_libcurl.txt`
  33
  34   This enables using CRAM-MD5 in an imap tunnel without needing OpenSSL.
  35
  36 * Use libcurl for send email
  37
  38   - `patches/km/git-send-email-libcurl.txt`
  39
  40   My own patches to make `git-send-email.perl` use libcurl instead of
  41   OpenSSL.  Has not been posted elsewhere.
  42
  43 * Use a different pack.windowmemory default setting instead of 0
  44
  45   - `patches/windowmemory/q/t_util_sys__memsize.diff`
  46   - `patches/windowmemory/q/t_gc_default-windowmemory.diff`
  47
  48   My own patches to change the pack.windowmemory default from 0 (meaning
  49   unlimited) to a sane default that should avoid memory thrashing especially
  50   when running gc --aggressive with a 64-bit address space.  Has not been
  51   posted elsewhere.
  52
  53 * Avoid PERL5LIB etc. variable conflicts
  54
  55   - `patches/km/no-perl-vars.txt`
  56
  57   My own patch to unset troublesome Perl environment variables before running
  58   subcommands.  This prevents incompatible PERL5LIB libraries from being picked
  59   up by Git's perl-based utilities.  Has not been posted elsewhere.
  60
  61 * Allow notes refs to be anywhere if given in full
  62
  63   - `patches/sc/any-notes-ref.txt`
  64   - `patches/km/any-notes-ref-tests.txt`
  65
  66   Both patches included in the thread and discussion at:
  67   <http://thread.gmane.org/gmane.comp.version-control.git/257281>.
  68
  69 * Make git-remote-mediawiki work properly:
  70
  71   - `patches/mediawiki/q/t_mediawiki_no-dupes.diff`
  72   - `patches/mediawiki/q/t_mediawiki_namespaces.diff`
  73   - `patches/mediawiki/q/t_mediawiki_max-revision.diff`
  74   - `patches/mediawiki/q/t_mediawiki_mediaimport.diff`
  75   - `patches/mediawiki/q/t_mediawiki_many-revisions.difff`
  76   - `patches/mediawiki/q/t_mediawiki_empty-commit.diff`
  77   - `patches/mediawiki/q/t_mediawiki_skip-notfound-media.diff`
  78
  79   My own patches to make git-remote-mediawiki work properly.  The no-dupes
  80   patch avoids importing more than one copy of the same history (typically it
  81   would import two copies).  The max-revision patch allows it to actually find
  82   the correct maximum revision so that a fetchStrategy of 'by_rev' can work
  83   properly.  The namespaces patch allows a 'by_rev' fetchStrategy to fetch an
  84   update regardless of what namespace it's located in when no pages or
  85   categories have been set to otherwise limit the import.  The mediaimport
  86   patch allows it to actually find the media to import when the mediaimport
  87   flag is set to true and the media has a timestamp that does not exactly match
  88   the page's down to the last second.  The many-revisions patch allows a
  89   fetchStrategy of 'by_rev' to succeed when the number of revisions that need
  90   to be fetched is very larg.  The empty-commit patch preserves a MediaWiki
  91   revision that only has a comment when can happen if the revision data has
  92   somehow been obliterated.  And finally the skip-notfound-media patch treats
  93   a 404 (and 403) error the same as an imageinfo query that finds nothing when
  94   mediaimport has been enabled.  Have not been posted elsewhere.
  95
  96 * Improve usability of git-instaweb:
  97
  98   - `patches/instaweb/q/t_instaweb_highlight.diff`
  99   - `patches/instaweb/q/t_instaweb_mimetypes.diff`
 100   - `patches/instaweb/q/t_instaweb_defaults.diff`
 101   - `patches/instaweb/q/t_instaweb_git-browser.diff`
 102   - `patches/instaweb/q/t_instaweb_ipv6.diff`
 103   - `patches/instaweb/q/t_instaweb_fcgi.diff`
 104   - `patches/instaweb/q/t_instaweb_readme.diff`
 105   - `patches/instaweb/q/t_instaweb_default-to-local.diff`
 106   - `patches/instaweb/q/t_instaweb_no-kill-nothing.diff`
 107   - `patches/instaweb/q/t_instaweb_auto-port.diff`
 108
 109   My own patches to improve the usability of git instaweb by enabling source
 110   highlighting if highlight is available, using the installed copy of
 111   mime.types (since there isn't such a file in OS X), enabling pathinfo mode,
 112   blame and better rename detection, adding a 'graphiclog' link to the pages
 113   that uses git-browser to show a graphic representation of commit ancestry,
 114   binding to both IPv4 and IPv6 addresses and browsing to localhost instead of
 115   127.0.0.1, enabling readme blob display, defaulting to binding only to the
 116   localhost address if `instaweb.local` has not been set at all, avoiding
 117   attempting to kill using a process id of "" and finally attempting to
 118   automatically select an available port to listen on if one was not specified
 119   and the first chosen port is not available.  The ipv6 patch is only effective
 120   when using lighttpd as the web server (which is the default).  The fcgi patch
 121   enables FCGI mode when the needed FCGI perl module is present.  Have not been
 122   posted elsewhere.
 123
 124 * Add submodule support to gitweb:
 125
 126   - `patches/gitweb/q/gitweb-find-project-dirs-with-.git-gitdir-links.diff`
 127
 128   My own patch to allow gitweb to find submodules that use gitdir links.  With
 129   this patch using git instaweb in a working tree that contains checked-out
 130   submodules makes it very easy to browse the submodules -- without the patch
 131   they are not listed in the gitweb projects list.  Has not been posted
 132   elsewhere.
 133
 134 * Various gitweb bug fixes / enhancements:
 135
 136 - `patches/gitweb/q/*.diff`
 137
 138   A selection of various patches from Girocco's [1] custom version of
 139   gitweb [2] that vastly improves the usability of git instaweb by making
 140   gitweb work so much better.
 141
 142   [1] <http://repo.or.cz/w/girocco.git>
 143   [2] <http://repo.or.cz/w/git/gitweb.git/blob/girocco:README_FIRST.txt>
 144
 145 * contrib/git-log-times:
 146
 147   - `patches/km/contrib-git-log-times.txt`
 148
 149   My own patch that adds contrib/git-log-times a git log --oneline alternative
 150   that includes dates, times and initials.  See the README file in the patch.
 151   Has not been posted elsewhere.
 152
 153
 154 Curl Patches
 155 ------------
 156
 157 In order to provide compatibility with Mac OS X 10.4 AND web sites using
 158 SHA-256/SHA-384 hashes in their certificates, the version of libcurl that has
 159 been included as part of the Git OS X Installer uses the darwinssl backend
 160 that relies on Secure Transport instead of OpenSSL.
 161
 162 Unfortunately the released version of the darwinssl backend has many
 163 deficiencies that make it unsuitable for use as a replacement when users are
 164 expecting to be able to provide multiple client certificates possibly combined
 165 with an RSA private key all in PEM format.
 166
 167 Additionally the as-released darwinssl backend doesn't really work on older
 168 Mac OS X versions as-is.  Oh it may compile on Mac OS X 10.5 without complaints
 169 but it immediately crashes and burns when one tries to use it.  And it does not
 170 support Mac OS X 10.4 at all as released.
 171
 172 * Curl darwinssl backend universal Mac OS X compatibility
 173
 174   - `patches/curl/curl_darwinssl_macosx.c`
 175   - `patches/curl/stcompat.c`
 176   - `patches/curl/stcompat.h`
 177   - `patches/curl/q/t_ntlm_no-one-shot.diff`
 178   - `patches/curl/q/t_securetransport_extra-data.diff`
 179   - `patches/curl/q/t_pinning_darwin.diff`
 180   - `patches/curl/q/t_pinning_dummy-key.diff`
 181
 182 * Curl mk-ca-bundle script improvements
 183
 184   - `patches/curl/q/t_mk-ca-bundle_improvements.diff`
 185
 186
 187 Lighttpd Patches
 188 ----------------
 189
 190 * Provide an idle timeout option
 191
 192   - `patches/lighttpd/q/t_server_idle-timeout.diff`
 193
 194 * A couple of other lighttpd patches are included to
 195   avoid having to maintain multiple patch series, but
 196   their changes are not relevant to the Git OS X Installer.
 197
 198
 199 GnuPG Patches
 200 -------------
 201
 202 The standard build of gpg does not allow one to create any keys with bit
 203 lengths larger than 4096 bits.  (Once created, existing versions of gpg can
 204 use such a key without problems.)  However, according to NIST 800-57, a RSA key
 205 3072 bits in length only provides 128 bits of security strength.  In order to
 206 comply with NIST policy on the use of AES to protect national information and
 207 meet the TOP SECRET requirements a security strength of at least 192 bits is
 208 required.  That necessitates an RSA key of 7680 bits (see NIST 800-57).  Hence
 209 the gpg patch to permit creation of such keys.
 210
 211 * Always allow larger RSA keys up to 16384 bits to be created
 212
 213   - `patches/gnupg/q/t_gnupg_longer-keys.diff`
 214
 215 * Make trailing ":pid:protocol" part of GPG_AGENT_INFO optional (launchd)
 216
 217   - `patches/gnupg/q/t_launchd_agent-compat.diff`
 218
 219
 220 Compatibility Patches
 221 ---------------------
 222
 223 Other than the giant Curl darwinssl backend patch, some other compatibility
 224 patches are needed in order to build for Mac OS X 10.4 without losing any
 225 functionality.
 226
 227 These consist of the remaining files in the include and src subdirectories
 228 and provide the following compatibility fixes:
 229
 230 * Curl support for NTLM on Mac OS X 10.4
 231
 232   Special thanks to Libtomcrypt <http://libtom.org/> for providing a public
 233   domain version of DES needed to make this work.
 234
 235 * Git support CRAM-MD5 when `git-imap-send` is using a tunnel
 236
 237   This is really just some glue and an implementation of HMAC MD5 based
 238   on RFC 2104 that uses the OS X Common Crypto MD5 hash implementation.
 239
 240 * GnuPG support using libedit instead of libreadline
 241
 242   This is just some simplistic linker glue (`src/gnupgcompat.c`) and a clever
 243   compiler prefix file (`src/gnupg-prefix.h`).
 244
 245
 246 Other Stuff
 247 -----------
 248
 249 For the neophyte using gpg the first time can be rather intimidating.  To this
 250 end a copy of the GNU Privacy Handbook has been included here in doc/gnupg.  It
 251 has not been modified and was simply copied from the original location at
 252 <https://www.gnupg.org/gph/en/manual.html>.