From fadf9088db875f1c04de4dc00ec3448f7dc408e6 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Tue, 9 Aug 2011 08:22:58 +0200 Subject: [PATCH] docs/ipc: make the GET_MARKS docs a little more precise --- docs/ipc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/ipc b/docs/ipc index 2cc5261f..4093ffce 100644 --- a/docs/ipc +++ b/docs/ipc @@ -60,8 +60,9 @@ GET_TREE (4):: every container. The reply will be the JSON-encoded tree (see the reply section). GET_MARKS (5):: - Gets a list of marks. The reply will be a JSON-encoded list of window marks - (see reply section). + Gets a list of marks (identifiers for containers to easily jump to them + later). The reply will be a JSON-encoded list of window marks (see + reply section). So, a typical message could look like this: -------------------------------------------------- @@ -425,8 +426,10 @@ JSON dump: === GET_MARKS reply -The reply consists of a single array of strings for each -window that has a mark. +The reply consists of a single array of strings for each container that has a +mark. The order of that array is undefined. If more than one container has the +same mark, it will be represented multiple times in the reply (the array +contents are not unique). If no window has a mark the response will be the empty array []. ------------------------ -- 2.39.5