ceph/src/jaegertracing/thrift/test/audit/README.md

   1 Typical usage
   2 =============
   3 ```
   4 thrift.exe --audit <oldFile> <newFile>
   5 ```
   6 Example run
   7 ===========
   8 ```
   9 > thrift.exe --audit test.thrift break1.thrift
  10 [Thrift Audit Failure:break1.thrift] New Thrift File has missing function base_function3
  11 [Thrift Audit Warning:break1.thrift] Constant const3 has different value
  12 ```
  13
  14 Problems that the audit tool can catch
  15 ======================================
  16 Errors
  17 * Removing an enum value
  18 * Changing the type of a struct field
  19 * Changing the required-ness of a struct field
  20 * Removing a struct field
  21 * Adding a required struct field
  22 * Adding a struct field 'in the middle'.  This usually indicates an old ID has been recycled
  23 * Struct removed
  24 * Oneway-ness change
  25 * Return type change
  26 * Missing function
  27 * Missing service
  28 * Change in service inheritance
  29
  30 Warnings
  31 * Removing a language namespace declaration
  32 * Changing a namespace
  33 * Changing an enum value's name
  34 * Removing an enum class
  35 * Default value changed
  36 * Struct field name change
  37 * Removed constant
  38 * Type of constant changed
  39 * Value of constant changed
  40