Browse Source

Add last fix to changelog and api docs

tags/v1.4.0
Nils 4 years ago
parent
commit
ce21702de3
2 changed files with 20 additions and 12 deletions
  1. +3
    -1
      CHANGELOG
  2. +17
    -11
      docs/src/api/index.adoc

+ 3
- 1
CHANGELOG View File

@@ -8,6 +8,7 @@ Legacy-GUI:
Scale icons, support more icon formats. Scale icons, support more icon formats.
Show all icons and buttons when attaching to a running nsmd session Show all icons and buttons when attaching to a running nsmd session
Various small fixes. Various small fixes.
Always show correct session name, no matter how the session was loaded or how the GUI was started


nsmd: nsmd:
NSM_API_VERSION_MINOR from 0 to 1 (1.0 -> 1.1) NSM_API_VERSION_MINOR from 0 to 1 (1.0 -> 1.1)
@@ -18,6 +19,7 @@ nsmd:
Users get informed by client-label if an executable is not present on the system or permission denied Users get informed by client-label if an executable is not present on the system or permission denied
Fixed reply for listing sessions from a plain "Done." to proper reply path with empty string as terminal symbol "/reply", "/nsm/server/list", "" Fixed reply for listing sessions from a plain "Done." to proper reply path with empty string as terminal symbol "/reply", "/nsm/server/list", ""
Fix operation reply to last treated client instead to reply to sender (Picot, Mathieu / houston) Fix operation reply to last treated client instead to reply to sender (Picot, Mathieu / houston)
/nsm/gui/session/name send consistent session name/relative-path pair to the annouced GUI, no matter how the session was loaded.


nsm.h nsm.h
:optional-gui: support to nsm.h, for other applications to include and use. (Meyer, Hermann / brummer ) :optional-gui: support to nsm.h, for other applications to include and use. (Meyer, Hermann / brummer )
@@ -47,7 +49,7 @@ Current state of upstream Non Session Manager v1.2 including unreleased /nsm/gui


1.2.0 / 2017-07-08 1.2.0 / 2017-07-08
Last release of Non-Session-Manager. Last release of Non-Session-Manager.
Commit 1904aba516341287ac297cefbbcd185f643e5538
Commit 1904aba516341287ac297cefbbcd185f643e5538




1.1.0 / 2012-03-03 1.1.0 / 2012-03-03


+ 17
- 11
docs/src/api/index.adoc View File

@@ -746,10 +746,10 @@ inrecement to `API_VERSION_MAJOR`, which we want to avoid.
`nsmd` checks if the clients `API_VERSION_MAJOR` is greater than its own and refuses the client `nsmd` checks if the clients `API_VERSION_MAJOR` is greater than its own and refuses the client
with `ERR_INCOMPATIBLE_API`. 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,`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,`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 New actions for server-control, for example a hypothetical `/nsm/server/save_as`, which would be
triggered by the client and would only be *answered* by the server ("no unrequested message") will triggered by the client and would only be *answered* by the server ("no unrequested message") will
@@ -789,19 +789,25 @@ Rewritten API document without code changes to adapt to existing code or existin
It was never an arbitrary value. 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, * <<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 is now finalized with sending and empty string "" as session name. Previously this was just
a symbolically irrelevant console message `"Done."` a symbolically irrelevant console message `"Done."`
* 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.
* unstable `/nsm/gui` protocol: 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.
* Replies to `/nsm/server/save` etc. will now be sent back to the sender and not falsely to the last * 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 client who replied to `/nsm/client/save`. This alone would only require API_VERSION_PATCH
increment, but we are already incrementing minor. increment, but we are already incrementing minor.
* <<Server Control API>>: `/nsm/server/add` was replying with an undocumented error code on success. * <<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."`. Instead, as this document always specificed, it now sends `"/reply", path, "Launched."`.
Again, this would have been just API_VERSION_PATCH on its own. 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.

Loading…
Cancel
Save