← Back to branch summary

~ps10gel/ubuntu/xenial/trafficserver/6.2.0

« back to all changes in this revision

Viewing changes to CRUFT.txt

  • Committer: Package Import Robot
  • Author(s): Aron Xu
  • Date: 2013-05-09 01:00:04 UTC
  • mto: (1.1.11) (5.3.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 15.
  • Revision ID: package-import@ubuntu.com-20130509010004-9fqq9n0adseg3f8w
Tags: upstream-3.3.2
Import upstream version 3.3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
CRUFT.txt
 
1
CRUFT
 
2
*****
 
3
 
 
4
This file is designated for tracking cruft in our code. That is, code paths
 
5
or ugly hacks that were put into place for a reason: Getting stuff to work
 
6
but which could either been done better, or which time will obsolete.
 
7
 
 
8
Examples are crude workarounds for broken compilers, libraries, OSes, or
 
9
hardware, or or massive ``#ifdef`` clusters, that are better abstracted away
 
10
into autoconf and convenience wrappers.
 
11
 
 
12
If you are new to the project this is a good place to look for explanations
 
13
of why things are the way they are, or help us fix things and make the code
 
14
easier to read and maintain.
 
15
 
 
16
 
 
17
Store.cc
 
18
========
 
19
``iocore/cache/Store.cc`` contains three different ``#ifdef`` clusters with
 
20
near identical code. Often you will read the same confused comment in three
 
21
places, see for instance: http://issues.apache.org/jira/browse/TS-1707
 
22
 
 
23
Web2
 
24
====
 
25
``mgmt/web2`` is very old, very broken, very deeply infested code that needs
 
26
to be removed as it is no longer appropriate, or functional.
 
27
Please see https://issues.apache.org/jira/browse/TS-641 for further refernece.