From: Omar Polo <op@omarpolo.com>
Date: Thu, 12 Aug 2021 12:59:45 +0000 (+0200)
Subject: Mention `find-ignore-file' in the vc.el commentary
X-Git-Tag: emacs-28.0.90~1542
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=45cfa2a8cd521b81770a123aff548abae70f7322;p=emacs.git

Mention `find-ignore-file' in the vc.el commentary

* lisp/vc/vc.el: Update documentation in the comments about
`find-ignore-file' (bug#50013).
---

diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 9338b7191d0..a97caa702a1 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -486,11 +486,19 @@
 ;;   from ignored files.
 ;;   When called from Lisp code, if DIRECTORY is non-nil, the
 ;;   repository to use will be deduced by DIRECTORY.
+;;   The default behavior is to add or remove a line from the file
+;;   returned by the `find-ignore-file' function.
 ;;
 ;; - ignore-completion-table (directory)
 ;;
 ;;   Return the completion table for files ignored by the current
 ;;   version control system, e.g., the entries in `.gitignore' and
+;;   `.bzrignore'.  The default behavior is to read the contents of
+;;   the file returned by the `find-ignore-file' function.
+;;
+;; - find-ignore-file
+;;
+;;   Return the ignore file that controls FILE, e.g. `.gitignore' or
 ;;   `.bzrignore'.
 ;;
 ;; - previous-revision (file rev)