Mailing-List: contact dev-help@trafficserver.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@trafficserver.apache.org
Content-type: text/plain; charset=utf-8
MIME-version: 1.0 (Mac OS X Mail 9.3 \(3124\))
Subject: Re: RFC: self-contained headers
From: James Peach <jamespeach@me.com>
In-reply-to: <1784317483.2525971.1467504688404.JavaMail.yahoo@mail.yahoo.com>
Date: Sat, 02 Jul 2016 21:40:26 -0700
Content-transfer-encoding: quoted-printable
Message-id: <5B130F1B-CC9B-4A79-A9B7-D1940DF2F485@me.com>
References: <79ABA682-CB30-4786-B6C8-394D2229FE4B@apache.org>
 <6CBF1E89-8425-49B5-8A4D-BC7C599B85B0@apache.org>
 <1784317483.2525971.1467504688404.JavaMail.yahoo@mail.yahoo.com>
To: dev@trafficserver.apache.org, Alan Carroll <solidwallofcode@yahoo-inc.com>
archived-at: Sun, 03 Jul 2016 04:40:51 -0000


> On Jul 2, 2016, at 5:11 PM, Alan Carroll =
<solidwallofcode@yahoo-inc.com.INVALID> wrote:
>=20
> Yes, it's unclear to me what "self contained" means. Obviously we =
can't have exactly one header file for Traffic Server, so include must =
be allowed. What property of the current header file structure doesn't =
include sufficiently to make clang-tidy happy?=20

By self-contained I mean that each header #includes all the others that =
it depends on. For example, if you have to #include a bunch of other =
headers in your .cc before you include foo.h, then foo.h is not =
self-contained. It would be self-contained if it #included everything =
that it needed.

One specific example. I_Lock.h is not self contained because it =
doesn=E2=80=99t #include the headers needed for RefCountObj, Ptr and a =
bunch of other stuff. To make clang-tidy changes to a header file, you =
would do this:

/opt/clang/bin/clang-tidy -fix -fix-errors I_Lock.h -- c++ =
-DHAVE_CONFIG_H -I. -I../../lib  -I../../lib -I../../lib/records =
-Ddarwin -DDEBUG -D_DEBUG -D_LARGEFILE64_SOURCE=3D1 =
-D_COMPILE64BIT_SOURCE=3D1 -D_GNU_SOURCE -D_REENTRANT =
-D__STDC_LIMIT_MACROS=3D1 -D__STDC_FORMAT_MACROS=3D1 =
-I/usr/local/Cellar/openssl/1.0.2h_1/include -DOPENSSL_NO_SSL_INTERN =
-I/System/Library/Frameworks/Tcl.framework/Versions/8.5/Headers =
-I/usr/local/include -I/usr/local/Cellar/pcre/8.39/include  -O0 =
-std=3Dc++11 -g -pipe -Wall -Wno-deprecated-declarations =
-Qunused-arguments -Werror -Wno-invalid-offsetof -mcx16 -x c++

Note that the header itself is passes to clang-tidy, so for the code in =
the header to be valid in this context, clang-tidy needs to see all the =
prerequisites.

J=