diff options
| author | Stefan Kangas <stefankangas@gmail.com> | 2019-07-13 12:11:19 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2019-07-13 14:17:13 +0300 |
| commit | 34ee26dd93613849802bfe40cd7fae3df0b57fd1 (patch) | |
| tree | 793b39cb18aa1b353734db54a53c1b92c43f4901 | |
| parent | 305abae50e8e10471125be6cdf3a7270befea0b0 (diff) | |
| download | emacs-34ee26dd93613849802bfe40cd7fae3df0b57fd1.tar.gz | |
Add warning to bidi-display-reordering doc string
This explanation was given by Eli Zaretskii on emacs-devel.
For discussion, see:
https://lists.gnu.org/archive/html/emacs-devel/2019-07/msg00294.html
* src/buffer.c (syms_of_buffer): Add warning to doc string of
bidi-display-reordering to explain that it should only be used for
debugging.
| -rw-r--r-- | src/buffer.c | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/buffer.c b/src/buffer.c index 12620f0d4aa..ffd74d477bd 100644 --- a/src/buffer.c +++ b/src/buffer.c @@ -5626,8 +5626,9 @@ This variable is never applied to a way of decoding a file while reading it. */ DEFVAR_PER_BUFFER ("bidi-display-reordering", &BVAR (current_buffer, bidi_display_reordering), Qnil, - doc: /* Non-nil means reorder bidirectional text for display in the visual order. */); - + doc: /* Non-nil means reorder bidirectional text for display in the visual order. +Setting this to nil is intended for use in debugging the display code. +Don't set to nil in normal sessions, as that is not supported. */); DEFVAR_PER_BUFFER ("bidi-paragraph-start-re", &BVAR (current_buffer, bidi_paragraph_start_re), Qnil, doc: /* If non-nil, a regexp matching a line that starts OR separates paragraphs. |