aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJuanma Barranquero2014-03-26 16:57:13 +0100
committerJuanma Barranquero2014-03-26 16:57:13 +0100
commit16adf2e6eb1ddf0b32ebea2d5ce8fa1e4c226614 (patch)
tree29b782fd6e7c44a834dd09442a551520e30bcbd6 /doc
parent5af73b0fe8975eeb47fb270819b4143c18d71caa (diff)
parent196716cf35f81bea108c3b75362e92c86ed1c016 (diff)
downloademacs-16adf2e6eb1ddf0b32ebea2d5ce8fa1e4c226614.tar.gz
emacs-16adf2e6eb1ddf0b32ebea2d5ce8fa1e4c226614.zip
Merge from emacs-24; up to 2014-03-23T23:14:52Z!yamaoka@jpl.org
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog13
-rw-r--r--doc/lispref/files.texi54
-rw-r--r--doc/lispref/markers.texi10
-rw-r--r--doc/lispref/text.texi9
-rw-r--r--doc/misc/ChangeLog8
-rw-r--r--doc/misc/texinfo.tex28
-rw-r--r--doc/misc/tramp.texi21
7 files changed, 110 insertions, 33 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 71af1bc66a0..fdc266472e0 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,16 @@
12014-03-26 Eli Zaretskii <eliz@gnu.org>
2
3 * files.texi (Kinds of Files): Improve documentation of
4 file-symlink-p. (Bug#17073) Add cross-references.
5
62014-03-26 Barry O'Reilly <gundaetiapo@gmail.com>
7
8 * markers.texi (Moving Marker Positions): The 2014-03-02 doc
9 change mentioning undo's inability to handle relocated markers no
10 longer applies. See bug#16818.
11 * text.texi (Undo): Expand documentation of (TEXT . POS) and
12 (MARKER . ADJUSTMENT) undo elements.
13
12014-03-26 Glenn Morris <rgm@gnu.org> 142014-03-26 Glenn Morris <rgm@gnu.org>
2 15
3 * files.texi (File Locks): All systems support locking. 16 * files.texi (File Locks): All systems support locking.
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index a00fa5b4795..64ed3a05ee6 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -950,22 +950,26 @@ as directories, symbolic links, and ordinary files.
950@defun file-symlink-p filename 950@defun file-symlink-p filename
951@cindex file symbolic links 951@cindex file symbolic links
952If the file @var{filename} is a symbolic link, the 952If the file @var{filename} is a symbolic link, the
953@code{file-symlink-p} function returns the (non-recursive) link target 953@code{file-symlink-p} function returns its (non-recursive) link target
954as a string. (Determining the file name that the link points to from 954as a string. (The link target string is not necessarily the full
955the target is nontrivial.) First, this function recursively follows 955absolute file name of the target; determining the full file name that
956symbolic links at all levels of parent directories. 956the link points to is nontrivial, see below.) If the leading
957 957directories of @var{filename} include symbolic links, this function
958If the file @var{filename} is not a symbolic link (or there is no such file), 958recursively follows them.
959
960If the file @var{filename} is not a symbolic link, or does not exist,
959@code{file-symlink-p} returns @code{nil}. 961@code{file-symlink-p} returns @code{nil}.
960 962
963Here are a few examples of using this function:
964
961@example 965@example
962@group 966@group
963(file-symlink-p "foo") 967(file-symlink-p "not-a-symlink")
964 @result{} nil 968 @result{} nil
965@end group 969@end group
966@group 970@group
967(file-symlink-p "sym-link") 971(file-symlink-p "sym-link")
968 @result{} "foo" 972 @result{} "not-a-symlink"
969@end group 973@end group
970@group 974@group
971(file-symlink-p "sym-link2") 975(file-symlink-p "sym-link2")
@@ -976,6 +980,40 @@ If the file @var{filename} is not a symbolic link (or there is no such file),
976 @result{} "/pub/bin" 980 @result{} "/pub/bin"
977@end group 981@end group
978@end example 982@end example
983
984Note that in the third example, the function returned @file{sym-link},
985but did not proceed to resolve it, although that file is itself a
986symbolic link. This is what we meant by ``non-recursive'' above---the
987process of following the symbolic links does not recurse if the link
988target is itself a link.
989
990The string that this function returns is what is recorded in the
991symbolic link; it may or may not include any leading directories.
992This function does @emph{not} expand the link target to produce a
993fully-qualified file name, and in particular does not use the leading
994directories, if any, of the @var{filename} argument if the link target
995is not an absolute file name. Here's an example:
996
997@example
998@group
999(file-symlink-p "/foo/bar/baz")
1000 @result{} "some-file"
1001@end group
1002@end example
1003
1004@noindent
1005Here, although @file{/foo/bar/baz} was given as a fully-qualified file
1006name, the result is not, and in fact does not have any leading
1007directories at all. And since @file{some-file} might itself be a
1008symbolic link, you cannot simply prepend leading directories to it,
1009nor even naively use @code{expand-file-name} (@pxref{File Name
1010Expansion}) to produce its absolute file name.
1011
1012For this reason, this function is seldom useful if you need to
1013determine more than just the fact that a file is or isn't a symbolic
1014link. If you actually need the file name of the link target, use
1015@code{file-chase-links} or @code{file-truename}, described in
1016@ref{Truenames}.
979@end defun 1017@end defun
980 1018
981The next two functions recursively follow symbolic links at 1019The next two functions recursively follow symbolic links at
diff --git a/doc/lispref/markers.texi b/doc/lispref/markers.texi
index 19386d638fe..51b87ab1e5b 100644
--- a/doc/lispref/markers.texi
+++ b/doc/lispref/markers.texi
@@ -344,12 +344,10 @@ specify the insertion type, create them with insertion type
344@section Moving Marker Positions 344@section Moving Marker Positions
345 345
346 This section describes how to change the position of an existing 346 This section describes how to change the position of an existing
347marker. When you do this, be sure you know how the marker is used 347marker. When you do this, be sure you know whether the marker is used
348outside of your program. For example, moving a marker to an unrelated 348outside of your program, and, if so, what effects will result from
349new position can cause undo to later adjust the marker incorrectly. 349moving it---otherwise, confusing things may happen in other parts of
350Often when you wish to relocate a marker to an unrelated position, it 350Emacs.
351is preferable to make a new marker and set the prior one to point
352nowhere.
353 351
354@defun set-marker marker position &optional buffer 352@defun set-marker marker position &optional buffer
355This function moves @var{marker} to @var{position} 353This function moves @var{marker} to @var{position}
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index f8a3e873449..7c5603fd645 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -1270,7 +1270,8 @@ This kind of element indicates how to reinsert text that was deleted.
1270The deleted text itself is the string @var{text}. The place to 1270The deleted text itself is the string @var{text}. The place to
1271reinsert it is @code{(abs @var{position})}. If @var{position} is 1271reinsert it is @code{(abs @var{position})}. If @var{position} is
1272positive, point was at the beginning of the deleted text, otherwise it 1272positive, point was at the beginning of the deleted text, otherwise it
1273was at the end. 1273was at the end. Zero or more (@var{marker} . @var{adjustment})
1274elements follow immediately after this element.
1274 1275
1275@item (t . @var{time-flag}) 1276@item (t . @var{time-flag})
1276This kind of element indicates that an unmodified buffer became 1277This kind of element indicates that an unmodified buffer became
@@ -1296,8 +1297,10 @@ Here's how you might undo the change:
1296@item (@var{marker} . @var{adjustment}) 1297@item (@var{marker} . @var{adjustment})
1297This kind of element records the fact that the marker @var{marker} was 1298This kind of element records the fact that the marker @var{marker} was
1298relocated due to deletion of surrounding text, and that it moved 1299relocated due to deletion of surrounding text, and that it moved
1299@var{adjustment} character positions. Undoing this element moves 1300@var{adjustment} character positions. If the marker's location is
1300@var{marker} @minus{} @var{adjustment} characters. 1301consistent with the (@var{text} . @var{position}) element preceding it
1302in the undo list, then undoing this element moves @var{marker}
1303@minus{} @var{adjustment} characters.
1301 1304
1302@item (apply @var{funname} . @var{args}) 1305@item (apply @var{funname} . @var{args})
1303This is an extensible undo item, which is undone by calling 1306This is an extensible undo item, which is undone by calling
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index e20fc9955e7..7c4a9551769 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,11 @@
12014-03-26 Paul Eggert <eggert@cs.ucla.edu>
2
3 * texinfo.tex: Update from gnulib.
4
52014-03-26 Michael Albinus <michael.albinus@gmx.de>
6
7 * tramp.texi (Frequently Asked Questions): Add fish shell settings.
8
12014-03-23 Katsumi Yamaoka <yamaoka@jpl.org> 92014-03-23 Katsumi Yamaoka <yamaoka@jpl.org>
2 10
3 * gnus.texi (Ma Gnus): Mention header attachment buttons. 11 * gnus.texi (Ma Gnus): Mention header attachment buttons.
diff --git a/doc/misc/texinfo.tex b/doc/misc/texinfo.tex
index 3e521840ca2..0f2673c849e 100644
--- a/doc/misc/texinfo.tex
+++ b/doc/misc/texinfo.tex
@@ -3,7 +3,7 @@
3% Load plain if necessary, i.e., if running under initex. 3% Load plain if necessary, i.e., if running under initex.
4\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi 4\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
5% 5%
6\def\texinfoversion{2014-02-16.16} 6\def\texinfoversion{2014-03-17.07}
7% 7%
8% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, 8% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 9% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
@@ -3935,19 +3935,23 @@ end
3935} 3935}
3936 3936
3937% multitable-only commands. 3937% multitable-only commands.
3938% 3938%
3939% @headitem starts a heading row, which we typeset in bold. 3939% @headitem starts a heading row, which we typeset in bold. Assignments
3940% Assignments have to be global since we are inside the implicit group 3940% have to be global since we are inside the implicit group of an
3941% of an alignment entry. \everycr resets \everytab so we don't have to 3941% alignment entry. \everycr below resets \everytab so we don't have to
3942% undo it ourselves. 3942% undo it ourselves.
3943\def\headitemfont{\b}% for people to use in the template row; not changeable 3943\def\headitemfont{\b}% for people to use in the template row; not changeable
3944\def\headitem{% 3944\def\headitem{%
3945 \checkenv\multitable 3945 \checkenv\multitable
3946 \crcr 3946 \crcr
3947 \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
3947 \global\everytab={\bf}% can't use \headitemfont since the parsing differs 3948 \global\everytab={\bf}% can't use \headitemfont since the parsing differs
3948 \the\everytab % for the first item 3949 \the\everytab % for the first item
3949}% 3950}%
3950% 3951%
3952% default for tables with no headings.
3953\let\headitemcrhook=\relax
3954%
3951% A \tab used to include \hskip1sp. But then the space in a template 3955% A \tab used to include \hskip1sp. But then the space in a template
3952% line is not enough. That is bad. So let's go back to just `&' until 3956% line is not enough. That is bad. So let's go back to just `&' until
3953% we again encounter the problem the 1sp was intended to solve. 3957% we again encounter the problem the 1sp was intended to solve.
@@ -3978,15 +3982,15 @@ end
3978 % 3982 %
3979 \everycr = {% 3983 \everycr = {%
3980 \noalign{% 3984 \noalign{%
3981 \global\everytab={}% 3985 \global\everytab={}% Reset from possible headitem.
3982 \global\colcount=0 % Reset the column counter. 3986 \global\colcount=0 % Reset the column counter.
3983 % Check for saved footnotes, etc. 3987 %
3988 % Check for saved footnotes, etc.:
3984 \checkinserts 3989 \checkinserts
3985 % Keeps underfull box messages off when table breaks over pages. 3990 %
3986 %\filbreak 3991 % Perhaps a \nobreak, then reset:
3987 % Maybe so, but it also creates really weird page breaks when the 3992 \headitemcrhook
3988 % table breaks over pages. Wouldn't \vfil be better? Wait until the 3993 \global\let\headitemcrhook=\relax
3989 % problem manifests itself, so it can be fixed for real --karl.
3990 }% 3994 }%
3991 }% 3995 }%
3992 % 3996 %
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 6dd5d2a88d8..c0a6156a4cf 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -3053,15 +3053,28 @@ setting the cursor at the top of the buffer, and applying the expression
3053If it fails, or the cursor is not moved at the end of the buffer, your 3053If it fails, or the cursor is not moved at the end of the buffer, your
3054prompt is not recognized correctly. 3054prompt is not recognized correctly.
3055 3055
3056A special problem is the zsh, which uses left-hand side and right-hand 3056A special problem is the zsh shell, which uses left-hand side and
3057side prompts in parallel. Therefore, it is necessary to disable the 3057right-hand side prompts in parallel. Therefore, it is necessary to
3058zsh line editor on the remote host. You shall add to @file{~/.zshrc} 3058disable the zsh line editor on the remote host. You shall add to
3059the following command: 3059@file{~/.zshrc} the following command:
3060 3060
3061@example 3061@example
3062[ $TERM = "dumb" ] && unsetopt zle && PS1='$ ' 3062[ $TERM = "dumb" ] && unsetopt zle && PS1='$ '
3063@end example 3063@end example
3064 3064
3065Similar fancy prompt settings are known from the fish shell. Here you
3066must add in @file{~/.config/fish/config.fish}:
3067
3068@example
3069function fish_prompt
3070 if test $TERM = "dumb"
3071 echo "\$ "
3072 else
3073 @dots{}
3074 end
3075end
3076@end example
3077
3065Furthermore it has been reported, that @value{tramp} (like sshfs, 3078Furthermore it has been reported, that @value{tramp} (like sshfs,
3066incidentally) doesn't work with WinSSHD due to strange prompt settings. 3079incidentally) doesn't work with WinSSHD due to strange prompt settings.
3067 3080