Skip to content

Commit

Permalink
CA-389206: Add comment for changing the CLI interface
Browse files Browse the repository at this point in the history
Signed-off-by: Ming Lu <[email protected]>
  • Loading branch information
minglumlu committed Feb 27, 2024
1 parent 98b55d6 commit f0b43f6
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions ocaml/xapi-cli-protocol/cli_protocol.ml
Original file line number Diff line number Diff line change
Expand Up @@ -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. *)
Expand Down

0 comments on commit f0b43f6

Please sign in to comment.