GNU bug report logs - #34949
27.0.50; Docstring of `vc-deduce-fileset' incomplete

Previous Next

Full log

View this message in rfc822 format

From: Juri Linkov <juri <at> linkov.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: p.stephani2 <at> gmail.com, 34949 <at> debbugs.gnu.org, larsi <at> gnus.org, dgutov <at> yandex.ru
Subject: bug#34949: 27.0.50; Docstring of `vc-deduce-fileset' incomplete
Date: Sun, 12 Apr 2020 02:38:01 +0300

>> Do you know what 'implicit' model means here and where to find all other
>> possible model values?
>
> They are documented in the doc string of 'vc-checkout-model'.
>
>> Also please help to find all possible states like
>> 'up-to-date' here.  I see more states used in vc-deduce-fileset like
>> 'missing', 'ignored', 'needs-update', but where is a complete list?
>
> The full list is in the doc string of 'vc-state'.
>
> is anything else missing to document these additional return values?

Sorry, I missed these docstrings, so here's a possible patch:

diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 0fd36b7c56..0bc7370a87 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -1027,8 +1027,9 @@ vc-deduce-fileset
 Otherwise, throw an error.
 
 STATE-MODEL-ONLY-FILES if non-nil, means that the caller needs
-the FILESET-ONLY-FILES STATE and MODEL info.  Otherwise, that
-part may be skipped.
+the FILESET-ONLY-FILES, STATE and MODEL info.  Otherwise, that
+part may be skipped.  Possible values of STATE are explained
+in `vc-state', and MODEL in `vc-checkout-model'.
 
 BEWARE: this function may change the current buffer."
   (let (backend)

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.