From f0b43f678cbdb32d1f0f11f75ad84200340158de Mon Sep 17 00:00:00 2001 From: Ming Lu Date: Mon, 26 Feb 2024 20:45:15 +0800 Subject: [PATCH] CA-389206: Add comment for changing the CLI interface Signed-off-by: Ming Lu --- ocaml/xapi-cli-protocol/cli_protocol.ml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/ocaml/xapi-cli-protocol/cli_protocol.ml b/ocaml/xapi-cli-protocol/cli_protocol.ml index 38d0f76871c..1fc8d95d11d 100644 --- a/ocaml/xapi-cli-protocol/cli_protocol.ml +++ b/ocaml/xapi-cli-protocol/cli_protocol.ml @@ -26,6 +26,13 @@ let minor = 2 a totally different kind of server (eg a standard HTTP server) *) let prefix = "XenSource thin CLI protocol" +(* Be careful to add/remove/modify the commands. The CLI interface is expected + to be extreme stable. Please keep following in mind when doing the changes: + 1. backwards compatibility support. E.g. a very old CLI client may need to + be supported still, + 2. a new command should be one for general purpose only rather than for a + specific usage. *) + (** Command sent by the server to the client. If the command is "Save" then the server waits for "OK" from the client and then streams a list of data chunks to the client. *)