You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@thrift.apache.org by be...@apache.org on 2015/07/10 03:56:08 UTC
thrift git commit: Renamed, relocated,
and reformated the audit tool's readme file
Repository: thrift
Updated Branches:
refs/heads/master 3ea26be2a -> 012dd4e3f
Renamed, relocated, and reformated the audit tool's readme file
Project: http://git-wip-us.apache.org/repos/asf/thrift/repo
Commit: http://git-wip-us.apache.org/repos/asf/thrift/commit/012dd4e3
Tree: http://git-wip-us.apache.org/repos/asf/thrift/tree/012dd4e3
Diff: http://git-wip-us.apache.org/repos/asf/thrift/diff/012dd4e3
Branch: refs/heads/master
Commit: 012dd4e3fc1e75e3434f608ce2ba30dbd29c56cb
Parents: 3ea26be
Author: Ben Craig <be...@apache.org>
Authored: Thu Jul 9 20:55:53 2015 -0500
Committer: Ben Craig <be...@apache.org>
Committed: Thu Jul 9 20:55:53 2015 -0500
----------------------------------------------------------------------
compiler/cpp/src/audit/readme.txt | 32 ---------------------------
test/audit/README.md | 40 ++++++++++++++++++++++++++++++++++
2 files changed, 40 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/thrift/blob/012dd4e3/compiler/cpp/src/audit/readme.txt
----------------------------------------------------------------------
diff --git a/compiler/cpp/src/audit/readme.txt b/compiler/cpp/src/audit/readme.txt
deleted file mode 100644
index f1c53e3..0000000
--- a/compiler/cpp/src/audit/readme.txt
+++ /dev/null
@@ -1,32 +0,0 @@
-Typical usage:
- thrift.exe --audit <oldFile> <newFile>
-Example run:
- > thrift.exe --audit test.thrift break1.thrift
- [Thrift Audit Failure:break1.thrift] New Thrift File has missing function base_function3
- [Thrift Audit Warning:break1.thrift] Constant const3 has different value
-
-Problems that the audit tool can catch:
-Errors
- Removing an enum value
- Changing the type of a struct field
- Changing the required-ness of a struct field
- Removing a struct field
- Adding a required struct field
- Adding a struct field 'in the middle'. This usually indicates an old ID has been recycled
- Struct removed
- Oneway-ness change
- Return type change
- Missing function
- Missing service
- Change in service inheritance
-Warnings
- Removing a language namespace declaration
- Changing a namespace
- Changing an enum value's name
- Removing an enum class
- Default value changed
- Struct field name change
- Removed constant
- Type of constant changed
- Value of constant changed
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/thrift/blob/012dd4e3/test/audit/README.md
----------------------------------------------------------------------
diff --git a/test/audit/README.md b/test/audit/README.md
new file mode 100644
index 0000000..412f8d5
--- /dev/null
+++ b/test/audit/README.md
@@ -0,0 +1,40 @@
+Typical usage
+=============
+```
+thrift.exe --audit <oldFile> <newFile>
+```
+Example run
+===========
+```
+> thrift.exe --audit test.thrift break1.thrift
+[Thrift Audit Failure:break1.thrift] New Thrift File has missing function base_function3
+[Thrift Audit Warning:break1.thrift] Constant const3 has different value
+```
+
+Problems that the audit tool can catch
+======================================
+Errors
+* Removing an enum value
+* Changing the type of a struct field
+* Changing the required-ness of a struct field
+* Removing a struct field
+* Adding a required struct field
+* Adding a struct field 'in the middle'. This usually indicates an old ID has been recycled
+* Struct removed
+* Oneway-ness change
+* Return type change
+* Missing function
+* Missing service
+* Change in service inheritance
+
+Warnings
+* Removing a language namespace declaration
+* Changing a namespace
+* Changing an enum value's name
+* Removing an enum class
+* Default value changed
+* Struct field name change
+* Removed constant
+* Type of constant changed
+* Value of constant changed
+
\ No newline at end of file