git commit: CRUFT.txt: Track the horrible things we do

[ig...@apache.org]

Updated Branches:
  refs/heads/master 3c51b612f -> 0f436307a


CRUFT.txt: Track the horrible things we do

CRUFT.txt is a place where we track the mistakes we deliberately make
to make things temporarily, that is, until better compilers, libraries,
OSes, machines come up ;) -- or, until a better programmer comes along
and fixes @igalic's horrible code.


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/0f436307
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/0f436307
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/0f436307

Branch: refs/heads/master
Commit: 0f436307a4ed1454840763aa95877aabd21f82fc
Parents: 3c51b61
Author: Igor Galić <i....@brainsware.org>
Authored: Wed Mar 20 18:22:17 2013 +0100
Committer: Igor Galić <i....@brainsware.org>
Committed: Wed Mar 20 18:22:17 2013 +0100

----------------------------------------------------------------------
 CRUFT.txt |   27 +++++++++++++++++++++++++++
 1 files changed, 27 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/0f436307/CRUFT.txt
----------------------------------------------------------------------
diff --git a/CRUFT.txt b/CRUFT.txt
new file mode 100644
index 0000000..634fadd
--- /dev/null
+++ b/CRUFT.txt
@@ -0,0 +1,27 @@
+CRUFT
+*****
+
+This file is designated for tracking cruft in our code. That is, code paths
+or ugly hacks that were put into place for a reason: Getting stuff to work
+but which could either been done better, or which time will obsolete.
+
+Examples are crude workarounds for broken compilers, libraries, OSes, or
+hardware, or or massive ``#ifdef`` clusters, that are better abstracted away
+into autoconf and convenience wrappers.
+
+If you are new to the project this is a good place to look for explanations
+of why things are the way they are, or help us fix things and make the code
+easier to read and maintain.
+
+
+Store.cc
+========
+``iocore/cache/Store.cc`` contains three different ``#ifdef`` clusters with
+near identical code. Often you will read the same confused comment in three
+places, see for instance: http://issues.apache.org/jira/browse/TS-1707
+
+Web2
+====
+``mgmt/web2`` is very old, very broken, very deeply infested code that needs
+to be removed as it is no longer appropriate, or functional.
+Please see https://issues.apache.org/jira/browse/TS-641 for further refernece.