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, 13 Apr 2020 02:51:17 +0300 Organization: LINKOV.NET Message-ID: <87blnwclfu.fsf@mail.linkov.net> References: <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> <83sghdnjaa.fsf@gnu.org> <87d08d3ct2.fsf@mail.linkov.net> <83imi5kybv.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="92975"; 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: p.stephani2@gmail.com, 34949@debbugs.gnu.org, larsi@gnus.org, dgutov@yandex.ru To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Apr 13 01:55: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 1jNmRU-000O5S-Di for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 13 Apr 2020 01:55:12 +0200 Original-Received: from localhost ([::1]:38884 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNmRT-0004xY-Dp for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 12 Apr 2020 19:55:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56776) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNmRL-0004xM-BV for bug-gnu-emacs@gnu.org; Sun, 12 Apr 2020 19:55:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jNmRK-0004hM-CG for bug-gnu-emacs@gnu.org; Sun, 12 Apr 2020 19:55:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:47482) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jNmRK-0004h9-9V for bug-gnu-emacs@gnu.org; Sun, 12 Apr 2020 19:55:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jNmRK-00078V-9U for bug-gnu-emacs@gnu.org; Sun, 12 Apr 2020 19:55:02 -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, 12 Apr 2020 23:55: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 fixed Original-Received: via spool by 34949-submit@debbugs.gnu.org id=B34949.158673565227367 (code B ref 34949); Sun, 12 Apr 2020 23:55:02 +0000 Original-Received: (at 34949) by debbugs.gnu.org; 12 Apr 2020 23:54:12 +0000 Original-Received: from localhost ([127.0.0.1]:59028 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jNmQV-00077L-P5 for submit@debbugs.gnu.org; Sun, 12 Apr 2020 19:54:11 -0400 Original-Received: from relay7-d.mail.gandi.net ([217.70.183.200]:57861) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jNmQT-000776-BF for 34949@debbugs.gnu.org; Sun, 12 Apr 2020 19:54:09 -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 relay7-d.mail.gandi.net (Postfix) with ESMTPSA id 6FFCC20002; Sun, 12 Apr 2020 23:54:01 +0000 (UTC) In-Reply-To: <83imi5kybv.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 12 Apr 2020 09:33:24 +0300") 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:178282 Archived-At: > Here's my take on that doc string (please double-check for accuracy): > > "Deduce a set of files and a backend to which to apply an operation. > Return a list of the form: > > (BACKEND FILESET FILESET-ONLY-FILES STATE CHECKOUT-MODEL) > > where the last 3 members are optional, and must be present only if > STATE-MODEL-ONLY-FILES is non-nil. > > NOT-STATE-CHANGING, if non-nil, means that the operation > requesting the fileset doesn't intend to change the VC state, > such as when printing the log or showing the diffs. > > If the current buffer is in `vc-dir' or Dired mode, FILESET is the > list of marked files, or the current directory if no files are > marked. > Otherwise, if the current buffer is visiting a version-controlled > file, FILESET is a single-file list containing that file's name. > Otherwise, if ALLOW-UNREGISTERED is non-nil and the visited file > is unregistered, FILESET is a single-file list containing the > name of the visited file. > Otherwise, throw an error. > > STATE-MODEL-ONLY-FILES, if non-nil, means that the caller needs > the FILESET-ONLY-FILES, STATE, and CHECKOUT-MODEL info. Otherwise, > these 3 members may be omitted from the returned list. Everything is correct, I couldn't have said it better myself. > BEWARE: this function may change the current buffer." > > Btw, the "change the current buffer" in the last sentence is > ambiguous. Does it mean switch to another buffer, or does it mean > modify the buffer text? I assume the former, so maybe say "may switch > to another buffer" explicitly. Correct, this means switching to another buffer. The only thing I don't see in your fixed docstring are the references to possible values in `vc-state' and `vc-checkout-model'. Are they needed?