Document that the Thrift generated files are patched (jaegertracing#50)

Signed-off-by: Craig Ringer <craig@2ndquadrant.com>
ringerc · Feb 1, 2018 · c36adcf · c36adcf
1 parent 2e22904
commit c36adcf
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,24 @@
 # cpp-client
 C++ OpenTracing binding for Jaeger
 
+## Generated files
+
+This project uses Apache Thrift for wire-format protocol support code
+generation. It currently requires exactly Thrift 0.9.2 or 0.9.3. Patches have
+been applied to the generated code so it cannot be directly re-generated from
+the IDL in the `idl` submodule
+
+(see https://github.com/jaegertracing/cpp-client/issues/45)
+
+The code can be re-generated with
+
+    git submodule init
+    git submodule update
+    find idl/thrift/ -type f -name \*.thrift -exec thrift -gen cpp -out src/jaegertracing/thrift-gen {} \;
+
+but at time of writing (Thrift 0.11.0) the resulting code is invalid due to
+https://issues.apache.org/jira/browse/THRIFT-4484
+
 [ci-img]: https://travis-ci.org/jaegertracing/cpp-client.svg?branch=master
 [ci]: https://travis-ci.org/jaegertracing/cpp-client
 [cov-img]: https://codecov.io/gh/jaegertracing/cpp-client/branch/master/graph/badge.svg

diff --git a/src/jaegertracing/thrift-gen/tracetest_types.cpp b/src/jaegertracing/thrift-gen/tracetest_types.cpp
@@ -1,8 +1,8 @@
 /**
- * Autogenerated by Thrift Compiler (0.9.2)
+ * MODIFIED from code autogenerated by Thrift Compiler (0.9.2)
  *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- *  @generated
+ * WARNING WARNING WARNING
+ * This file has been hand-patched. See https://github.com/jaegertracing/cpp-client/issues/45 .
  */
 #include "tracetest_types.h"
 

diff --git a/src/jaegertracing/thrift-gen/tracetest_types.h b/src/jaegertracing/thrift-gen/tracetest_types.h
@@ -1,8 +1,8 @@
 /**
- * Autogenerated by Thrift Compiler (0.9.2)
+ * MODIFIED from code autogenerated by Thrift Compiler (0.9.2)
  *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- *  @generated
+ * WARNING WARNING WARNING
+ * This file has been hand-patched. See https://github.com/jaegertracing/cpp-client/issues/45 .
  */
 #ifndef tracetest_TYPES_H
 #define tracetest_TYPES_H

diff --git a/src/jaegertracing/thrift-gen/zipkincore_constants.cpp b/src/jaegertracing/thrift-gen/zipkincore_constants.cpp
@@ -1,8 +1,8 @@
 /**
- * Autogenerated by Thrift Compiler (0.9.2)
+ * MODIFIED from code autogenerated by Thrift Compiler (0.9.2)
  *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- *  @generated
+ * WARNING WARNING WARNING
+ * This file has been hand-patched. See https://github.com/jaegertracing/cpp-client/issues/45 .
  */
 #include "zipkincore_constants.h"
 

diff --git a/src/jaegertracing/thrift-gen/zipkincore_constants.h b/src/jaegertracing/thrift-gen/zipkincore_constants.h
@@ -1,8 +1,8 @@
 /**
- * Autogenerated by Thrift Compiler (0.9.2)
+ * MODIFIED from code autogenerated by Thrift Compiler (0.9.2)
  *
- * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
- *  @generated
+ * WARNING WARNING WARNING
+ * This file has been hand-patched. See https://github.com/jaegertracing/cpp-client/issues/45 .
  */
 #ifndef zipkincore_CONSTANTS_H
 #define zipkincore_CONSTANTS_H