Improve the ediff-diff-options documentation
authorLars Ingebrigtsen <larsi@gnus.org>
Mon, 7 Feb 2022 00:38:41 +0000 (01:38 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Mon, 7 Feb 2022 03:58:49 +0000 (04:58 +0100)
* 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).

doc/misc/ediff.texi
lisp/vc/ediff-diff.el

index d81ba158a1946b5e88e60c20a21fd168413cc67f..39b09b29b3fdf1a40f52a90933df2583dd756e54 100644 (file)
@@ -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
index ca56a2851dbb15e5b7e7f33aef5f27891b3be739..07b853817d17ab5784075639a89b09ec67235413 100644 (file)
@@ -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)