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: Eli Zaretskii <eliz <at> gnu.org>
To: Juri Linkov <juri <at> linkov.net>
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: Thu, 09 Apr 2020 11:41:01 +0300

> From: Juri Linkov <juri <at> linkov.net>
> Date: Sun, 05 Apr 2020 02:37:52 +0300
> Cc: Lars Ingebrigtsen <larsi <at> gnus.org>, 34949 <at> debbugs.gnu.org,
>  Dmitry Gutov <dgutov <at> yandex.ru>
> 
> > It also doesn't explain the meaning of the return values
> > FILESET-ONLY-FILES, STATE, and CHECKOUT-MODEL.
> 
> This is hard to explain because this is internal data, I even don't know
> where to begin.  For example, here is some code from vc-next-action
> that uses data returned from vc-deduce-fileset:
> 
>   (not (eq model 'implicit)) (eq state 'up-to-date)
> 
> 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?

Previous Next

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