Moves includes into a "cctz" subdirectory.

This is a breaking change for users. Callers should now include cctz header files like: #include "cctz/civil_time.h"
google · Sep 6, 2017 · 5b17020 · 5b17020
1 parent 0e2dd88
commit 5b17020
Show file tree

Hide file tree

Showing 26 changed files with 58 additions and 55 deletions.
diff --git a/BUILD b/BUILD
@@ -20,10 +20,10 @@ cc_library(
     name = "civil_time",
     srcs = ["src/civil_time_detail.cc"],
     hdrs = [
-        "include/civil_time.h",
+        "include/cctz/civil_time.h",
     ],
     includes = ["include"],
-    textual_hdrs = ["include/civil_time_detail.h"],
+    textual_hdrs = ["include/cctz/civil_time_detail.h"],
     visibility = ["//visibility:public"],
 )
 
@@ -47,8 +47,8 @@ cc_library(
         "src/tzfile.h",
     ],
     hdrs = [
-        "include/time_zone.h",
-        "include/zone_info_source.h",
+        "include/cctz/time_zone.h",
+        "include/cctz/zone_info_source.h",
     ],
     includes = ["include"],
     visibility = ["//visibility:public"],

diff --git a/Makefile b/Makefile
@@ -40,7 +40,7 @@ DESTDIR ?=
 ## TEST_FLAGS = ...
 ## TEST_LIBS = ...
 
-VPATH = $(SRC)include:$(SRC)src:$(SRC)examples
+VPATH = $(SRC)src:$(SRC)examples
 CXXFLAGS += -g -Wall -I$(SRC)include -std=$(STD) \
             $(TEST_FLAGS) -fPIC -MMD
 ARFLAGS = rcs
@@ -53,10 +53,7 @@ CCTZ = cctz
 CCTZ_LIB = lib$(CCTZ).a
 CCTZ_SHARED_LIB = lib$(CCTZ).so
 
-CCTZ_HDRS =			\
-	civil_time.h		\
-	civil_time_detail.h	\
-	time_zone.h
+CCTZ_HDRS = $(SRC)/include/cctz/*.h
 
 CCTZ_OBJS =			\
 	civil_time_detail.o	\
@@ -87,8 +84,8 @@ $(CCTZ_SHARED_LIB): $(CCTZ_OBJS)
 install: install_hdrs install_lib
 
 install_hdrs: $(CCTZ_HDRS)
-	$(INSTALL) -d $(DESTDIR)$(PREFIX)/include
-	$(INSTALL) -m 644 -p $? $(DESTDIR)$(PREFIX)/include
+	$(INSTALL) -d $(DESTDIR)$(PREFIX)/include/cctz
+	$(INSTALL) -m 644 -p $? $(DESTDIR)$(PREFIX)/include/cctz
 
 install_lib: $(CCTZ_LIB)
 	$(INSTALL) -d $(DESTDIR)$(PREFIX)/lib

diff --git a/README.md b/README.md
@@ -8,10 +8,12 @@ zones in a simple and correct manner. The libraries in CCTZ are:
 
 * **The Civil-Time Library** &mdash; This is a header-only library that supports
   computing with human-scale time, such as dates (which are represented by the
-  `cctz::civil_day` class). This library is declared in [`include/civil_time.h`](https://github.com/google/cctz/blob/master/include/civil_time.h).
+  `cctz::civil_day` class). This library is declared in
+  [`include/cctz/civil_time.h`](https://github.com/google/cctz/blob/master/include/cctz/civil_time.h).
 * **The Time-Zone Library** &mdash; This library uses the IANA time zone
   database that is installed on the system to convert between *absolute time*
-  and *civil time*. This library is declared in [`include/time_zone.h`](https://github.com/google/cctz/blob/master/include/time_zone.h).
+  and *civil time*. This library is declared in
+  [`include/cctz/time_zone.h`](https://github.com/google/cctz/blob/master/include/cctz/time_zone.h).
 
 These libraries are currently known to work on **Linux** and **Mac OS X**. We
 are actively interested in help getting them working on Windows. Please contact
@@ -35,8 +37,10 @@ the sources using your existing build system.
 Next Steps:
 
 1.  See the documentation for the libraries in CCTZ:
-  * Civil Time: [`include/civil_time.h`](https://github.com/google/cctz/blob/master/include/civil_time.h)
-  * Time Zone: [`include/time_zone.h`](https://github.com/google/cctz/blob/master/include/time_zone.h)
+  * Civil Time:
+    [`include/cctz/civil_time.h`](https://github.com/google/cctz/blob/master/include/cctz/civil_time.h)
+  * Time Zone:
+    [`include/cctz/time_zone.h`](https://github.com/google/cctz/blob/master/include/cctz/time_zone.h)
 2.  Look at the examples in https://github.com/google/cctz/tree/master/examples
 3.  Join our mailing list to ask questions and keep informed of changes:
   * https://groups.google.com/forum/#!forum/cctz
@@ -93,10 +97,12 @@ implement the above concepts.
   [`<chrono>`](http://en.cppreference.com/w/cpp/chrono)
   library without modification. For example, an absolute point in time is
   represented by a `std::chrono::time_point`.
-* Civil time &mdash; This is implemented by the [`include/civil_time.h`](https://github.com/google/cctz/blob/master/include/civil_time.h) library
+* Civil time &mdash; This is implemented by the
+  [`include/cctz/civil_time.h`](https://github.com/google/cctz/blob/master/include/cctz/civil_time.h) library
   that is provided as part of CCTZ. For example, a "date" is represented by a
   `cctz::civil_day`.
-* Time zone &mdash; This is implemented by the [`include/time_zone.h`](https://github.com/google/cctz/blob/master/include/time_zone.h) library
+* Time zone &mdash; This is implemented by the
+  [`include/cctz/time_zone.h`](https://github.com/google/cctz/blob/master/include/cctz/time_zone.h) library
   that is provided as part of CCTZ. For example, a time zone is represented by
   an instance of the class `cctz::time_zone`.
 
@@ -110,7 +116,7 @@ day happens to be the 29th, we also output the day of the week.
 
 ```
 #include <iostream>
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 
 int main() {
   for (cctz::civil_day d(2016, 2, 1); d < cctz::civil_month(2016, 3); ++d) {
@@ -144,8 +150,8 @@ like to see what time it was for our friend watching in Sydney Australia.
 
 ```
 #include <iostream>
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 int main() {
   cctz::time_zone nyc;

diff --git a/examples/example1.cc b/examples/example1.cc
@@ -15,8 +15,8 @@
 #include <iostream>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 int main() {
   cctz::time_zone lax;

diff --git a/examples/example2.cc b/examples/example2.cc
@@ -16,7 +16,7 @@
 #include <iostream>
 #include <string>
 
-#include "time_zone.h"
+#include "cctz/time_zone.h"
 
 int main() {
   const std::string civil_string = "2015-09-22 09:35:00";

diff --git a/examples/example3.cc b/examples/example3.cc
@@ -16,8 +16,8 @@
 #include <iostream>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 int main() {
   cctz::time_zone lax;

diff --git a/examples/example4.cc b/examples/example4.cc
@@ -16,8 +16,8 @@
 #include <iostream>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 template <typename D>
 cctz::time_point<cctz::sys_seconds> FloorDay(cctz::time_point<D> tp,

diff --git a/examples/hello.cc b/examples/hello.cc
@@ -16,8 +16,8 @@
 #include <iostream>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 int main() {
   cctz::time_zone syd;

diff --git a/include/civil_time.h → include/cctz/civil_time.h b/include/civil_time.h → include/cctz/civil_time.h
@@ -15,7 +15,7 @@
 #ifndef CCTZ_CIVIL_TIME_H_
 #define CCTZ_CIVIL_TIME_H_
 
-#include "civil_time_detail.h"
+#include "cctz/civil_time_detail.h"
 
 namespace cctz {
 

diff --git a/include/civil_time_detail.h → include/cctz/civil_time_detail.h b/include/civil_time_detail.h → include/cctz/civil_time_detail.h
diff --git a/include/time_zone.h → include/cctz/time_zone.h b/include/time_zone.h → include/cctz/time_zone.h
@@ -25,7 +25,7 @@
 #include <string>
 #include <utility>
 
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 
 namespace cctz {
 

diff --git a/include/zone_info_source.h → include/cctz/zone_info_source.h b/include/zone_info_source.h → include/cctz/zone_info_source.h
diff --git a/src/benchmarks.cc b/src/benchmarks.cc
@@ -6,9 +6,9 @@
 #include <string>
 #include <vector>
 
-#include "civil_time.h"
 #include "benchmark/benchmark.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 #include "time_zone_impl.h"
 
 namespace {

diff --git a/src/civil_time_detail.cc b/src/civil_time_detail.cc
@@ -1,4 +1,4 @@
-#include "civil_time_detail.h"
+#include "cctz/civil_time_detail.h"
 
 #include <iomanip>
 #include <ostream>

diff --git a/src/civil_time_test.cc b/src/civil_time_test.cc
@@ -12,7 +12,7 @@
 //   See the License for the specific language governing permissions and
 //   limitations under the License.
 
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 
 #include <iomanip>
 #include <limits>

diff --git a/src/time_tool.cc b/src/time_tool.cc
@@ -26,8 +26,8 @@
 #include <sstream>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 #include "time_zone_impl.h"
 
 // Pulls in the aliases from cctz for brevity.

diff --git a/src/time_zone_fixed.h b/src/time_zone_fixed.h
@@ -17,7 +17,7 @@
 
 #include <string>
 
-#include "time_zone.h"
+#include "cctz/time_zone.h"
 
 namespace cctz {
 

diff --git a/src/time_zone_format.cc b/src/time_zone_format.cc
@@ -18,7 +18,7 @@
 # endif
 #endif
 
-#include "time_zone.h"
+#include "cctz/time_zone.h"
 
 #include <cctype>
 #include <chrono>
@@ -34,7 +34,7 @@
 #include <sstream>
 #endif
 
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 #include "time_zone_if.h"
 
 namespace cctz {

diff --git a/src/time_zone_format_test.cc b/src/time_zone_format_test.cc
@@ -12,14 +12,14 @@
 //   See the License for the specific language governing permissions and
 //   limitations under the License.
 
-#include "time_zone.h"
+#include "cctz/time_zone.h"
 
 #include <chrono>
 #include <iomanip>
 #include <sstream>
 #include <string>
 
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
 

diff --git a/src/time_zone_if.h b/src/time_zone_if.h
@@ -20,8 +20,8 @@
 #include <memory>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 namespace cctz {
 

diff --git a/src/time_zone_impl.h b/src/time_zone_impl.h
@@ -18,8 +18,8 @@
 #include <memory>
 #include <string>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 #include "time_zone_if.h"
 #include "time_zone_info.h"
 

diff --git a/src/time_zone_info.cc b/src/time_zone_info.cc
@@ -45,7 +45,7 @@
 #include <sstream>
 #include <string>
 
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 #include "time_zone_fixed.h"
 #include "time_zone_posix.h"
 

diff --git a/src/time_zone_info.h b/src/time_zone_info.h
@@ -21,11 +21,11 @@
 #include <string>
 #include <vector>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
+#include "cctz/zone_info_source.h"
 #include "time_zone_if.h"
 #include "tzfile.h"
-#include "zone_info_source.h"
 
 namespace cctz {
 

diff --git a/src/time_zone_libc.cc b/src/time_zone_libc.cc
@@ -23,8 +23,8 @@
 #include <tuple>
 #include <utility>
 
-#include "civil_time.h"
-#include "time_zone.h"
+#include "cctz/civil_time.h"
+#include "cctz/time_zone.h"
 
 namespace cctz {
 

diff --git a/src/time_zone_lookup.cc b/src/time_zone_lookup.cc
@@ -12,7 +12,7 @@
 //   See the License for the specific language governing permissions and
 //   limitations under the License.
 
-#include "time_zone.h"
+#include "cctz/time_zone.h"
 
 #include <cstdlib>
 #include <cstring>

diff --git a/src/time_zone_lookup_test.cc b/src/time_zone_lookup_test.cc
@@ -12,7 +12,7 @@
 //   See the License for the specific language governing permissions and
 //   limitations under the License.
 
-#include "time_zone.h"
+#include "cctz/time_zone.h"
 
 #include <chrono>
 #include <cstddef>
@@ -21,7 +21,7 @@
 #include <thread>
 #include <vector>
 
-#include "civil_time.h"
+#include "cctz/civil_time.h"
 #include "gtest/gtest.h"
 
 using std::chrono::time_point_cast;