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 fgetln when getdelim is not available
  44
  45   - `patches/km/strbuf_getwholeline-fgetln.txt`
  46
  47   My own patches to make `strbuf_getwholeline` use fgetln when called with
  48   a delimiter of `\n` if fgetln is available but getdelim is not.
  49   Has not been posted elsewhere.
  50
  51 * Use a different pack.windowmemory default setting instead of 0
  52
  53   - `patches/windowmemory/q/t_util_sys__memsize.diff`
  54   - `patches/windowmemory/q/t_gc_default-windowmemory.diff`
  55
  56   My own patches to change the pack.windowmemory default from 0 (meaning
  57   unlimited) to a sane default that should avoid memory thrashing especially
  58   when running gc --aggressive with a 64-bit address space.  Has not been
  59   posted elsewhere.
  60
  61 * Avoid PERL5LIB etc. variable conflicts
  62
  63   - `patches/km/no-perl-vars.txt`
  64
  65   My own patch to unset troublesome Perl environment variables before running
  66   subcommands.  This prevents incompatible PERL5LIB libraries from being picked
  67   up by Git's perl-based utilities.  Has not been posted elsewhere.
  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 large.  The empty-commit patch preserves a MediaWiki
  91   revision that only has a comment which 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   - `patches/instaweb/q/t_instaweb_restrict-bare.diff`
 109
 110   My own patches to improve the usability of git instaweb by enabling source
 111   highlighting if highlight is available, using the installed copy of
 112   mime.types (since there isn't such a file in OS X), enabling pathinfo mode,
 113   blame and better rename detection, adding a 'graphiclog' link to the pages
 114   that uses git-browser to show a graphic representation of commit ancestry,
 115   binding to both IPv4 and IPv6 addresses and browsing to localhost instead of
 116   127.0.0.1, enabling readme blob display, defaulting to binding only to the
 117   localhost address if `instaweb.local` has not been set at all, avoiding
 118   attempting to kill using a process id of "", attempting to automatically
 119   select an available port to listen on if one was not specified and the first
 120   chosen port is not available and finally set the gitweb configuration item
 121   $projects_list_restrict when running in a bare repository.  The ipv6 patch is
 122   only effective when using lighttpd as the web server (which is the default).
 123   The fcgi patch enables FCGI mode when the needed FCGI perl module is present.
 124   Have not been posted elsewhere.
 125
 126 * Add submodule support to gitweb:
 127
 128   - `patches/gitweb/q/gitweb-find-project-dirs-with-.git-gitdir-links.diff`
 129
 130   My own patch to allow gitweb to find submodules that use gitdir links.  With
 131   this patch using git instaweb in a working tree that contains checked-out
 132   submodules makes it very easy to browse the submodules -- without the patch
 133   they are not listed in the gitweb projects list.  Has not been posted
 134   elsewhere.
 135
 136 * Add $projects_list_restrict support to gitweb:
 137
 138   - `patches/gitweb/q/gitweb-support-projects_list_restrict.diff`
 139
 140   My own patch to allow gitweb to restrict the projects found when
 141   $projects_list is set to a directory to only those in a single subdirectory
 142   or those with a full path that matches a specified regular expression.
 143   Has not been posted elsewhere.
 144
 145 * Various gitweb bug fixes / enhancements:
 146
 147 - `patches/gitweb/q/*.diff`
 148
 149   A selection of various patches from Girocco's [1] custom version of
 150   gitweb [2] that vastly improves the usability of git instaweb by making
 151   gitweb work so much better.
 152
 153   [1] <http://repo.or.cz/w/girocco.git>
 154   [2] <http://repo.or.cz/w/git/gitweb.git/blob/girocco:README_FIRST.txt>
 155
 156 * contrib/git-log-times:
 157
 158   - `patches/km/contrib-git-log-times.txt`
 159
 160   My own patch that adds contrib/git-log-times a git log --oneline alternative
 161   that includes dates, times and initials.  See the README file in the patch.
 162   Has not been posted elsewhere.
 163
 164
 165 Curl Patches
 166 ------------
 167
 168 In order to provide compatibility with Mac OS X 10.4 AND web sites using
 169 SHA-256/SHA-384 hashes in their certificates, the version of libcurl that has
 170 been included as part of the Git OS X Installer uses the darwinssl backend
 171 that relies on Secure Transport instead of OpenSSL.
 172
 173 Unfortunately the released version of the darwinssl backend has many
 174 deficiencies that make it unsuitable for use as a replacement when users are
 175 expecting to be able to provide multiple client certificates possibly combined
 176 with an RSA private key all in PEM format.
 177
 178 Additionally the as-released darwinssl backend doesn't really work on older
 179 Mac OS X versions as-is.  Oh it may compile on Mac OS X 10.5 without complaints
 180 but it immediately crashes and burns when one tries to use it.  And it does not
 181 support Mac OS X 10.4 at all as released.
 182
 183 * Curl darwinssl backend universal Mac OS X compatibility
 184
 185   - `patches/curl/curl_darwinssl_macosx.c`
 186   - `patches/curl/stcompat.c`
 187   - `patches/curl/stcompat.h`
 188   - `patches/curl/q/t_ntlm_no-one-shot.diff`
 189   - `patches/curl/q/t_securetransport_extra-data.diff`
 190   - `patches/curl/q/t_vtls_reuse-client-session.diff`
 191   - `patches/curl/q/t_pinning_darwin.diff`
 192   - `patches/curl/q/t_pinning_dummy-key.diff`
 193
 194 * Curl mk-ca-bundle script improvements
 195
 196   - `patches/curl/q/t_mk-ca-bundle_improvements.diff`
 197
 198
 199 Lighttpd Patches
 200 ----------------
 201
 202 * Provide an idle timeout option
 203
 204   - `patches/lighttpd/q/t_server_idle-timeout.diff`
 205
 206 * A couple of other lighttpd patches are included to
 207   avoid having to maintain multiple patch series, but
 208   their changes are not relevant to the Git OS X Installer.
 209
 210
 211 GnuPG Patches
 212 -------------
 213
 214 The standard build of gpg does not allow one to create any keys with bit
 215 lengths larger than 4096 bits.  (Once created, existing versions of gpg can
 216 use such a key without problems.)  However, according to NIST 800-57, a RSA key
 217 3072 bits in length only provides 128 bits of security strength.  In order to
 218 comply with NIST policy on the use of AES to protect national information and
 219 meet the TOP SECRET requirements a security strength of at least 192 bits is
 220 required.  That necessitates an RSA key of 7680 bits (see NIST 800-57).  Hence
 221 the gpg patch to permit creation of such keys.
 222
 223 * Always allow larger RSA keys up to 16384 bits to be created
 224
 225   - `patches/gnupg/q/t_gnupg_longer-keys.diff`
 226
 227 * Make trailing ":pid:protocol" part of GPG_AGENT_INFO optional (launchd)
 228
 229   - `patches/gnupg/q/t_launchd_agent-compat.diff`
 230
 231
 232 Compatibility Patches
 233 ---------------------
 234
 235 Other than the giant Curl darwinssl backend patch, some other compatibility
 236 patches are needed in order to build for Mac OS X 10.4 without losing any
 237 functionality.
 238
 239 These consist of the remaining files in the include and src subdirectories
 240 and provide the following compatibility fixes:
 241
 242 * Curl support for NTLM on Mac OS X 10.4
 243
 244   Special thanks to Libtomcrypt <http://libtom.org/> for providing a public
 245   domain version of DES needed to make this work.
 246
 247 * Git support CRAM-MD5 when `git-imap-send` is using a tunnel
 248
 249   This is really just some glue and an implementation of HMAC MD5 based
 250   on RFC 2104 that uses the OS X Common Crypto MD5 hash implementation.
 251
 252 * GnuPG support using libedit instead of libreadline
 253
 254   This is just some simplistic linker glue (`src/gnupgcompat.c`) and a clever
 255   compiler prefix file (`src/gnupg-prefix.h`).
 256
 257
 258 Other Stuff
 259 -----------
 260
 261 For the neophyte using gpg the first time can be rather intimidating.  To this
 262 end a copy of the GNU Privacy Handbook has been included here in doc/gnupg.  It
 263 has not been modified and was simply copied from the original location at
 264 <https://www.gnupg.org/gph/en/manual.html>.