summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuc Teirlinck <teirllm@auburn.edu>2004-03-18 02:57:32 +0000
committerLuc Teirlinck <teirllm@auburn.edu>2004-03-18 02:57:32 +0000
commit186f9ad113998e2f9c8caa43b872fd5ad51d38be (patch)
tree916285b52e0bb9a4b627b4670cf33a4e6ab68865
parent165a7fbe6655561aeb78fd2856b60f4c83d9c635 (diff)
downloademacs-186f9ad113998e2f9c8caa43b872fd5ad51d38be.tar.gz
(clone-buffer): Doc fix.
-rw-r--r--lisp/simple.el19
1 files changed, 15 insertions, 4 deletions
diff --git a/lisp/simple.el b/lisp/simple.el
index 1f710576fa9..f41b9cbd11a 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -4313,11 +4313,22 @@ Returns nil if PROCESS has already terminated."
;; - syntax-table
;; - overlays
(defun clone-buffer (&optional newname display-flag)
- "Create a twin copy of the current buffer.
-If NEWNAME is nil, it defaults to the current buffer's name;
-NEWNAME is modified by adding or incrementing <N> at the end as necessary.
+ "Create and return a twin copy of the current buffer.
+Unlike an indirect buffer, the new buffer can be edited
+independently of the old one (if it is not read-only).
+NEWNAME is the name of the new buffer. It may be modified by
+adding or incrementing <N> at the end as necessary to create a
+unique buffer name. If nil, it defaults to the name of the
+current buffer, with the proper suffix. If DISPLAY-FLAG is
+non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
+clone a file-visiting buffer, or a buffer whose major mode symbol
+has a non-nil `no-clone' property, results in an error.
+
+Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
+current buffer with appropriate suffix. However, if a prefix
+argument is given, then the command prompts for NEWNAME in the
+minibuffer.
-If DISPLAY-FLAG is non-nil, the new buffer is shown with `pop-to-buffer'.
This runs the normal hook `clone-buffer-hook' in the new buffer
after it has been set up properly in other respects."
(interactive