bug#50013: document vc method `find-ignore-file'

bug#50013: document vc method `find-ignore-file'

[Omar Polo]

[-- Attachment #1: Type: text/plain, Size: 529 bytes --]

Tags: patch

Hi,

I noticed that the vc "method" `find-ignore-file' is used in
vc-default-ignore and vc-default-ignore-completion-table but it's not
documented.



In GNU Emacs 28.0.50 (build 10, x86_64-unknown-openbsd6.9, X toolkit, cairo version 1.16.0, Xaw scroll bars)
 of 2021-07-12 built on venera
Windowing system distributor 'The X.Org Foundation', version 11.0.12010000
System Description: OpenBSD venera 6.9 GENERIC.MP#158 amd64

Configured using:
 'configure --prefix=/home/op/opt/emacs --with-x-toolkit=lucid CC=cc'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-document-find-ignore-file.patch --]
[-- Type: text/patch, Size: 1142 bytes --]

From 734f95c33f3b618110a5c1376b46cc96336332d4 Mon Sep 17 00:00:00 2001
From: Omar Polo <op@omarpolo.com>
Date: Wed, 11 Aug 2021 16:25:20 +0000
Subject: [PATCH] document find-ignore-file

---
 lisp/vc/vc.el | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 9338b7191d..a97caa702a 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)
-- 
2.32.0

bug#50013: document vc method `find-ignore-file'

[Lars Ingebrigtsen]

Omar Polo <op@omarpolo.com> writes:

> I noticed that the vc "method" `find-ignore-file' is used in
> vc-default-ignore and vc-default-ignore-completion-table but it's not
> documented.

Thanks; applied to Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no