From: Eli Zaretskii <eliz@gnu.org>
Date: Tue, 1 Dec 2015 16:11:11 +0000 (+0200)
Subject: Document 'inhibit-read-only' property
X-Git-Tag: emacs-25.0.90~567
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=e702ab8d843dd416b6721c2e05be832d69ad1977;p=emacs.git

Document 'inhibit-read-only' property

* doc/lispref/text.texi (Special Properties): Describe the new
'inhibit-read-only' text property.  Add cross-reference to where
read-only buffers are described.
* doc/lispref/buffers.texi (Read Only Buffers): Mention that
'inhibit-read-only' property exempts text from being read-only.
Add cross-reference to "Special Properties".

* etc/NEWS: Move the entry about 'inhibit-read-only' property to
its place and mark it documented.
---

diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi
index 45a21c8e806..55fa5bcd6f0 100644
--- a/doc/lispref/buffers.texi
+++ b/doc/lispref/buffers.texi
@@ -716,7 +716,9 @@ The special commands of these modes bind @code{buffer-read-only} to
 
 @defvar buffer-read-only
 This buffer-local variable specifies whether the buffer is read-only.
-The buffer is read-only if this variable is non-@code{nil}.
+The buffer is read-only if this variable is non-@code{nil}.  However,
+characters that have the @code{inhibit-read-only} text property can
+still be modified.  @xref{Special Properties, inhibit-read-only}.
 @end defvar
 
 @defvar inhibit-read-only
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 85109415719..45373675998 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -3267,8 +3267,8 @@ and then remove the property.  @xref{Read Only Buffers}.
 
 @item inhibit-read-only
 @kindex inhibit-read-only @r{(text property)}
-If a character has the property @code{inhibit-read-only}, and the
-buffer is read-only, editing the character in question is allowed.
+Characters that have the property @code{inhibit-read-only} can be
+edited even in read-only buffers.  @xref{Read Only Buffers}.
 
 @item invisible
 @kindex invisible @r{(text property)}
diff --git a/etc/NEWS b/etc/NEWS
index 0e38db6544d..b9e0bd4ba24 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -181,9 +181,6 @@ for use in Emacs bug reports.
 hiding character but the default `.' can be used by let-binding the
 variable `read-hide-char'.
 
-** A new text property `inhibit-read-only' can be used in read-only
-buffers to allow certain parts of the text to be writable.
-
 ** A new function `directory-files-recursively' returns all matching
 files (recursively) under a directory.
 
@@ -1142,8 +1139,12 @@ process filter, sentinel, etc., through keyword arguments (similar to
 
 +++
 ** New variable `inhibit-message', when bound to non-nil, inhibits
-   `message' and related functions from displaying messages the Echo
-   Area.  The output is still logged to the *Messages* buffer.
+`message' and related functions from displaying messages the Echo
+Area.  The output is still logged to the *Messages* buffer.
+
++++
+** A new text property `inhibit-read-only' can be used in read-only
+buffers to allow certain parts of the text to be writable.
 
 ** `read-buffer' takes a new `predicate' argument.