all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Juri Linkov <juri@linkov.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: p.stephani2@gmail.com, 34949@debbugs.gnu.org, larsi@gnus.org,
	dgutov@yandex.ru
Subject: bug#34949: 27.0.50; Docstring of `vc-deduce-fileset' incomplete
Date: Mon, 13 Apr 2020 02:51:17 +0300	[thread overview]
Message-ID: <87blnwclfu.fsf@mail.linkov.net> (raw)
In-Reply-To: <83imi5kybv.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 12 Apr 2020 09:33:24 +0300")

> 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?





  reply	other threads:[~2020-04-12 23:51 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-22 17:50 bug#34949: 27.0.50; Docstring of `vc-deduce-fileset' incomplete Philipp Stephani
2019-10-09 22:40 ` Lars Ingebrigtsen
2019-12-24 19:53   ` Dmitry Gutov
2019-12-24 23:28     ` Juri Linkov
2020-02-17 23:42       ` Juri Linkov
2020-02-18 22:27         ` Dmitry Gutov
2020-02-18 23:36           ` Juri Linkov
2020-02-20 23:14             ` Juri Linkov
2020-02-21  0:22               ` Dmitry Gutov
2020-02-23  0:04                 ` Juri Linkov
2020-02-23  9:01                   ` Dmitry Gutov
2020-02-23 23:25                     ` Juri Linkov
2020-02-24  0:17                       ` Dmitry Gutov
2020-02-25  0:12                         ` Juri Linkov
2020-02-25 10:32                           ` Dmitry Gutov
2020-02-25 21:23                             ` Juri Linkov
2020-02-26 22:49                               ` Dmitry Gutov
2020-02-26 23:46                                 ` Juri Linkov
2020-02-27  7:28                                   ` Dmitry Gutov
2020-02-27 23:15                                     ` Juri Linkov
2020-02-28 19:22                                       ` Dmitry Gutov
2020-02-29 21:25                                         ` Juri Linkov
2020-02-29 22:25                                           ` Dmitry Gutov
2020-03-09 22:55                                             ` Juri Linkov
2020-03-12  0:08                                               ` Dmitry Gutov
2020-03-12  0:41                                                 ` Juri Linkov
2020-03-12 22:43                                                   ` Juri Linkov
2020-03-13 12:11                                                     ` Dmitry Gutov
2020-03-14 23:31                                                       ` Juri Linkov
2020-03-15 21:54                                                         ` Dmitry Gutov
2020-03-15 23:58                                                           ` Juri Linkov
2020-03-16 20:17                                                             ` Dmitry Gutov
2020-03-24 22:16                                                               ` Juri Linkov
2020-03-25 20:47                                                                 ` Juri Linkov
2020-03-25 21:32                                                                   ` Dmitry Gutov
2020-03-29 22:35                                                                     ` Juri Linkov
2020-03-30 19:53                                                                       ` Dmitry Gutov
2020-03-24 22:36                                                               ` Juri Linkov
2020-03-25 20:59                                                                 ` Juri Linkov
2020-03-25 21:15                                                                   ` Drew Adams
2020-03-25 21:50                                                                     ` Juri Linkov
2020-03-25 22:04                                                                       ` Drew Adams
2020-03-26 23:18                                                                         ` Juri Linkov
2020-03-27 16:11                                                                           ` Drew Adams
2020-03-27 22:41                                                                   ` Dmitry Gutov
2020-03-28 23:54                                                                     ` Juri Linkov
2020-03-29 18:41                                                                       ` Dmitry Gutov
2020-03-29 22:27                                                                         ` Juri Linkov
2020-03-30 20:01                                                                           ` Dmitry Gutov
2020-03-30 22:40                                                                             ` Juri Linkov
2020-03-30 23:22                                                                               ` Dmitry Gutov
2020-03-31  1:02                                                                               ` Drew Adams
2020-04-02 22:08                                                                             ` Juri Linkov
2020-04-03  0:21                                                                               ` Dmitry Gutov
2020-04-03 20:08                                                                               ` Philipp Stephani
2020-04-04 23:37                                                                                 ` Juri Linkov
2020-04-05  9:47                                                                                   ` Philipp Stephani
2020-04-05 23:05                                                                                     ` Juri Linkov
2020-04-09  8:41                                                                                   ` Eli Zaretskii
2020-04-11 23:38                                                                                     ` Juri Linkov
2020-04-12  6:33                                                                                       ` Eli Zaretskii
2020-04-12 23:51                                                                                         ` Juri Linkov [this message]
2020-04-13  4:31                                                                                           ` Eli Zaretskii
2020-04-13 23:25                                                                                             ` Juri Linkov
2020-03-25 21:59                                                                 ` Dmitry Gutov
2020-03-26 23:10                                                                   ` Juri Linkov
2020-03-26 23:51                                                                     ` Dmitry Gutov
2020-02-21  0:16             ` Dmitry Gutov
2019-12-25 21:45     ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87blnwclfu.fsf@mail.linkov.net \
    --to=juri@linkov.net \
    --cc=34949@debbugs.gnu.org \
    --cc=dgutov@yandex.ru \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.org \
    --cc=p.stephani2@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.