From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Mon, 7 Feb 2022 00:38:41 +0000 (+0100)
Subject: Improve the ediff-diff-options documentation
X-Git-Tag: emacs-29.0.90~2466
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=130cd70d9bea68099e9748af59fe812c248ca1f5;p=emacs.git

Improve the ediff-diff-options documentation

* lisp/vc/ediff-diff.el (ediff-diff-options):
* doc/misc/ediff.texi (Patch and Diff Programs): Note that setting
this variable directly is probably the wrong thing to do (bug#6512).
---

diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi
index d81ba158a19..39b09b29b3f 100644
--- a/doc/misc/ediff.texi
+++ b/doc/misc/ediff.texi
@@ -1866,7 +1866,8 @@ These variables specify the options to pass to the above utilities.
 In @code{ediff-diff-options}, it may be useful to specify options
 such as @samp{-w} that ignore certain kinds of changes.  However,
 Ediff does not let you use the option @samp{-c}, as it doesn't recognize this
-format yet.
+format yet.  (If you alter this variable, it should be done via the
+Customize interface instead of using @code{setq} directly.)
 
 @item ediff-coding-system-for-read
 @vindex ediff-coding-system-for-read
diff --git a/lisp/vc/ediff-diff.el b/lisp/vc/ediff-diff.el
index ca56a2851db..07b853817d1 100644
--- a/lisp/vc/ediff-diff.el
+++ b/lisp/vc/ediff-diff.el
@@ -85,7 +85,10 @@ options after the default ones.
 
 This variable is not for customizing the look of the differences produced by
 the command \\[ediff-show-diff-output].  Use the variable
-`ediff-custom-diff-options' for that."
+`ediff-custom-diff-options' for that.
+
+Setting this variable directly may not yield the expected
+results.  It should be set via the Customize interface instead."
   :set #'ediff-set-diff-options
   :type 'string)