From 77b159003dea94113e93ac4dd2481a09654ef0a9 Mon Sep 17 00:00:00 2001 From: Nils <> Date: Sun, 12 Jul 2020 01:01:56 +0200 Subject: [PATCH] generate new api html --- docs/api/index.html | 64 ++++++++++++++++++++------------------------- 1 file changed, 29 insertions(+), 35 deletions(-) diff --git a/docs/api/index.html b/docs/api/index.html index 15b3bdb..40be3cd 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -1329,7 +1329,7 @@ string.

2.6. Client to Server Control

-

If the server publishes the :server_control: capability, then clients can also initiate action by +

If the server publishes the :server-control: capability, then clients can also initiate action by the server. For example, a client might implement a 'Save All' option which sends a /nsm/server/save message to the server, rather than requiring the user to switch to the session management interface to effect the save.

@@ -1614,10 +1614,10 @@ inrecement to API_VERSION_MAJOR, which we want to avoid.

with ERR_INCOMPATIBLE_API.

-

All changes (that concern client/server behaviour) that increment API_VERSION_MINOR will be gated -by new capabilities (e.g. :optional-gui:). nsmd will not send any messages if a capability was -not sent by the client in announce. This includes mostly optional features about -requesting extra information.

+

All changes (that concern client/server behaviour) that increment API_VERSION_MINOR will be +request-only or gated by new capabilities (e.g. :optional-gui:). nsmd will not send any +messages if a capability was not sent by the client in announce. This includes +mostly optional features about requesting extra information.

New actions for server-control, for example a hypothetical /nsm/server/save_as, which would be @@ -1686,36 +1686,30 @@ It was never an arbitrary value.

-

Code changes:

+

Code changes: +* Server Control API: /nsm/server/list chain of single OSC messages, one for each session, + is now finalized with sending and empty string "" as session name. Previously this was just + a symbolically irrelevant console message "Done." +* Replies to /nsm/server/save etc. will now be sent back to the sender and not falsely to the last + client who replied to /nsm/client/save. This alone would only require API_VERSION_PATCH + increment, but we are already incrementing minor. +* Server Control API: /nsm/server/add was replying with an undocumented error code on success. + Instead, as this document always specificed, it now sends "/reply", path, "Launched.". + Again, this would have been just API_VERSION_PATCH on its own.

-
- +
+

Unstable /nsm/gui protocol +* Send client status after a GUI attaches to running server. This + was not happening before, but it was the intention. It was just broken in nsmd.cpp. This alone + would only require API_VERSION_PATCH increment, but we are already incrementing minor. +* Send label "launch error!" when a program is added (or loaded) that + does not exist in $PATH. This requires no adaptation of any client, server or GUI because labels + are arbitrary already and this is not meant for automatic parsing, but as user information. +* /nsm/gui/session/name will now always send the same parameter format, regardless of how the session was opened: + simple-session-name, relative session path with subdirs below session-root. +* When a GUI announces itself to nsmd it will receive the absolute path to the session directory + through the message /nsm/gui/session/root. This is not a new addition but was already in + non-session-manager git.

@@ -1724,7 +1718,7 @@ Again, this would have been just API_VERSION_PATCH on its own.