[lttng-dev] [RFC PATCH lttng-tools v2 07/20] Document inter-proccesses communication protocols requirements

[Yannick Lamarre]

The introduction of serialization changes previously established
requirements for lttng-tools.
This document drafts the guidelines to follow in future communication
protocol development.

Signed-off-by: Yannick Lamarre <ylamarre at efficios.com>
---
Unsure how this document should be structured and what specific information
should be kept here or even if it's the right place.
It might be interesting to move this to lttng-doc since it is likely to also
document communication protocols between consumers (ust and kernel modules)
and the sessiond.

 doc/comm-requirements.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 doc/comm-requirements.txt

diff --git a/doc/comm-requirements.txt b/doc/comm-requirements.txt
new file mode 100644
index 00000000..7f62260d
--- /dev/null
+++ b/doc/comm-requirements.txt
@@ -0,0 +1,9 @@
+LTTng Communication Protocols' Requirements
+Yannick Lamarre, April 2019
+
+This document describes the requirements for the development of communication
+protocols.
+The integration of serialization officially breaks from the implicit
+requirement to keep backward compatibility by removing padding fields from
+serialized structures. This forces users to upgrade in a lock-step fashion.
+
-- 
2.11.0