From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#34949: 27.0.50; Docstring of `vc-deduce-fileset' incomplete Date: Thu, 10 Oct 2019 00:40:56 +0200 Message-ID: <877e5dzgnb.fsf@gnus.org> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="66415"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 34949@debbugs.gnu.org To: Philipp Stephani Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Oct 10 00:41:15 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iIKdt-000H8Q-Sl for geb-bug-gnu-emacs@m.gmane.org; Thu, 10 Oct 2019 00:41:14 +0200 Original-Received: from localhost ([::1]:60608 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iIKds-0005Qa-5C for geb-bug-gnu-emacs@m.gmane.org; Wed, 09 Oct 2019 18:41:12 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:58866) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iIKdj-0005Ps-TY for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 18:41:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iIKdi-0001Q0-OD for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 18:41:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:45577) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iIKdi-0001Pt-Kx for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 18:41:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iIKdi-0000Jc-GA for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 18:41:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 09 Oct 2019 22:41:02 +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 Original-Received: via spool by 34949-submit@debbugs.gnu.org id=B34949.15706608621207 (code B ref 34949); Wed, 09 Oct 2019 22:41:02 +0000 Original-Received: (at 34949) by debbugs.gnu.org; 9 Oct 2019 22:41:02 +0000 Original-Received: from localhost ([127.0.0.1]:54398 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIKdh-0000JF-LC for submit@debbugs.gnu.org; Wed, 09 Oct 2019 18:41:01 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:46150) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iIKdg-0000J6-77 for 34949@debbugs.gnu.org; Wed, 09 Oct 2019 18:41:00 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iIKdc-0005aS-Kj; Thu, 10 Oct 2019 00:40:59 +0200 In-Reply-To: (Philipp Stephani's message of "Fri, 22 Mar 2019 18:50:52 +0100") 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:168815 Archived-At: Philipp Stephani writes: > The docstring of `vc-deduce-fileset' doesn't describe the OBSERVER > parameter. It also doesn't explain the meaning of the return values > FILESET-ONLY-FILES, STATE, and CHECKOUT-MODEL. The OBSERVER thing is a long-standing issue, and people have added comments about that parameter for decades. It now states (incorrectly): ;; FIXME: OBSERVER is unused. The name is not intuitive and is not ;; documented. It's set to t when called from diff and print-log. (let (backend) (cond ((derived-mode-p 'vc-dir-mode) (vc-dir-deduce-fileset state-model-only-files)) ((derived-mode-p 'dired-mode) (if observer (vc-dired-deduce-fileset) (error "State changing VC operations not supported in `dired-mode'"))) But we see that it's used, and used for one thing only: If we call this function in a dired buffer, the function will signal an error if OBSERVER is nil. So all the callers of this function pass in t if it's a non-state-changing operation. Or am I reading the code wrong? So the parameter does make some sense: OBSERVER non-nil means that it's a non-destructive operation we're doing to do (but we only care in dired buffers). Having that check in this function may be a bit odd, but... -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no