From 43e8edd3a39a1025a00d5f21dbcafa0d69935e31 Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Thu, 25 May 2017 09:02:10 +0100 Subject: [PATCH] Document the update-option command --- doc/manpages/commands.asciidoc | 16 ++++++++++------ doc/manpages/options.asciidoc | 19 ++++++++++++------- 2 files changed, 22 insertions(+), 13 deletions(-) diff --git a/doc/manpages/commands.asciidoc b/doc/manpages/commands.asciidoc index a849baec..bd7dd538 100644 --- a/doc/manpages/commands.asciidoc +++ b/doc/manpages/commands.asciidoc @@ -85,16 +85,24 @@ command *q!* has to be used). *nop*:: does nothing, but arguments will be evaluated (e.g. shell expansion) -*set* :: +*declare-option* [-hidden] []:: + declare a new option, the -hidden hides the option in completion + suggestions (c.f. the 'options' documentation page) + +*set-option* :: change the value of an option (c.f. the 'options' documentation page), note that the name of a particular buffer can be specified when the target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar"; the scope can also take the `current` special value, which will automatically point to the narrowest scope available in the current context -*unset* :: +*unset-option* :: unset the value of an option (c.f. the 'options' documentation page) +*update-option* :: + update the value of an option if its type supports that operation + (c.f. the 'options' documentation page) + *alias* :: define a new alias, within the context of a scope @@ -102,10 +110,6 @@ command *q!* has to be used). remove an alias if its current value is the same as the one passed as an optional parameter, remove it unconditionally otherwise -*declare-option* [-hidden] []:: - declare a new option, the -hidden hides the option in completion - suggestions (c.f. the 'options' documentation page) - *face* :: define a face (c.f. the 'faces' documentation page) diff --git a/doc/manpages/options.asciidoc b/doc/manpages/options.asciidoc index 6a853d68..a569ce1e 100644 --- a/doc/manpages/options.asciidoc +++ b/doc/manpages/options.asciidoc @@ -22,14 +22,19 @@ Types a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash *range-specs*:: - a `:` separated list of a pair of a buffer range - (`.,.` or - `.+`) and a string (separated by `|`), - except for the first element which is just the timestamp of the buffer. -*line-flags*:: + a `:` separated list of a pair of a buffer range (`.,.` or `.+`) and a string (separated by `|`), + except for the first element which is just the timestamp of + the buffer. When the `update-option` is used on an option of + this type, its ranges gets updated according to all the buffer + modifications that happened since its timestamp. +*line-specs*:: a `:` separated list of a line number and a corresponding flag - (`|`), except for the first element which is just the - timestamp of the buffer. + (`|`), except for the first element which is + just the timestamp of the buffer. When the `update-option` is + used on an option of this type, its lines gets updated according + to all the buffer modifications that happened since its timestamp. *completions*:: a `:` separated list of `||` candidates, except for the first element which follows the