From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.bugs Subject: bug#34949: 27.0.50; Docstring of `vc-deduce-fileset' incomplete Date: Mon, 06 Apr 2020 02:05:11 +0300 Organization: LINKOV.NET Message-ID: <87mu7pwn2w.fsf@mail.linkov.net> References: <875zfd9lzm.fsf@mail.linkov.net> <87mu8mieve.fsf@mail.linkov.net> <87k13pkxdl.fsf@mail.linkov.net> <207d4e30-aa59-b8eb-c39a-0957757f39eb@yandex.ru> <875zf6cy3w.fsf@mail.linkov.net> <9c39f788-29f1-5a68-c8f3-a4b08ae9ea3b@yandex.ru> <87lfo1dvcf.fsf@mail.linkov.net> <44cda45a-db93-f2c1-626d-9ace68cd6fd1@yandex.ru> <87y2rpqt28.fsf@mail.linkov.net> <874kuci4tx.fsf@mail.linkov.net> <786821a9-ceab-bbe8-b02a-69e77ddde426@yandex.ru> <878sjkjb8p.fsf@mail.linkov.net> <7d73cdd2-6af1-270c-1929-1bf618c304db@yandex.ru> <87tv26pzji.fsf@mail.linkov.net> <979c0191-48ce-f13f-361e-a03b3ff393a6@yandex.ru> <87a73t8rrl.fsf@mail.linkov.net> <87v9me960f.fsf@mail.linkov.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="92264"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (x86_64-pc-linux-gnu) Cc: Lars Ingebrigtsen , 34949@debbugs.gnu.org, Dmitry Gutov To: Philipp Stephani Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Apr 06 01:37:12 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jLEpE-000Ntr-1S for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 06 Apr 2020 01:37:12 +0200 Original-Received: from localhost ([::1]:52758 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jLEpD-0002C3-4G for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Apr 2020 19:37:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:39215) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jLEp4-0002Ba-Sc for bug-gnu-emacs@gnu.org; Sun, 05 Apr 2020 19:37:03 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jLEp3-0006AZ-Vj for bug-gnu-emacs@gnu.org; Sun, 05 Apr 2020 19:37:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:35338) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jLEp3-0006AP-T2 for bug-gnu-emacs@gnu.org; Sun, 05 Apr 2020 19:37:01 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jLEp3-0004vN-QK for bug-gnu-emacs@gnu.org; Sun, 05 Apr 2020 19:37:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Juri Linkov Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 05 Apr 2020 23:37:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 34949 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: confirmed fixed Original-Received: via spool by 34949-submit@debbugs.gnu.org id=B34949.158612976218752 (code B ref 34949); Sun, 05 Apr 2020 23:37:01 +0000 Original-Received: (at 34949) by debbugs.gnu.org; 5 Apr 2020 23:36:02 +0000 Original-Received: from localhost ([127.0.0.1]:46881 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jLEo6-0004sN-C8 for submit@debbugs.gnu.org; Sun, 05 Apr 2020 19:36:02 -0400 Original-Received: from relay6-d.mail.gandi.net ([217.70.183.198]:59169) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jLEo3-0004rY-U4 for 34949@debbugs.gnu.org; Sun, 05 Apr 2020 19:36:00 -0400 X-Originating-IP: 91.129.99.85 Original-Received: from mail.gandi.net (m91-129-99-85.cust.tele2.ee [91.129.99.85]) (Authenticated sender: juri@linkov.net) by relay6-d.mail.gandi.net (Postfix) with ESMTPSA id 78D7CC0005; Sun, 5 Apr 2020 23:35:51 +0000 (UTC) In-Reply-To: (Philipp Stephani's message of "Sun, 5 Apr 2020 11:47:10 +0200") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:178068 Archived-At: >> > 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? 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? > > Would it make sense to document these values as internal for now, > similar to what we do with the 11th return value of > parse-partial-sexp? Maybe. In this case the patch could be just: diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 0fd36b7c56..5da6edbd0c 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -1027,8 +1027,8 @@ 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 internal information. +Otherwise, that part may be skipped. BEWARE: this function may change the current buffer." (let (backend)