Skip to content

Commit 2ff8204

Browse files
author
Yuuki Harano
committed
Merge branch 'master' of https://github.com/emacs-mirror/emacs
2 parents 59b07ba + cc67d6e commit 2ff8204

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+2228
-1261
lines changed

INSTALL

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ some of the steps manually. The more detailed description in the other
3434
sections of this guide will help you do that, so please refer to those
3535
sections if you need to.
3636

37-
1. Unpacking the Emacs release requires about 200 MB of free
38-
disk space. Building Emacs uses about another 200 MB of space.
39-
The final installed Emacs uses about 150 MB of disk space.
40-
This includes the space-saving that comes from automatically
41-
compressing the Lisp source files on installation.
37+
1. Obtain and unpack the Emacs release, with commands like this:
38+
39+
wget https://ftp.gnu.org/gnu/emacs/emacs-VERSION.tar.xz
40+
tar -xf emacs-VERSION.tar.xz
41+
42+
where VERSION is the Emacs version number.
4243

4344
2a. 'cd' to the directory where you unpacked Emacs and invoke the
4445
'configure' script:
@@ -87,7 +88,7 @@ sections if you need to.
8788

8889
make install
8990

90-
You are now ready to use Emacs. If you wish to conserve disk space,
91+
You are now ready to use Emacs. If you wish to conserve space,
9192
you may remove the program binaries and object files from the
9293
directory where you built Emacs:
9394

@@ -118,7 +119,7 @@ packages. Note that if there is a separate 'dev' or 'devel' package,
118119
for use at compilation time rather than run time, you will need that
119120
as well as the corresponding run time package; typically the dev
120121
package will contain header files and a library archive. Otherwise,
121-
you can download the libraries from <http://www.nongnu.org/m17n/>.
122+
you can download the libraries from <https://www.nongnu.org/m17n/>.
122123

123124
Note that Emacs cannot support complex scripts on a TTY, unless the
124125
terminal includes such a support.
@@ -162,14 +163,14 @@ can be found (in the unlikely event that your distribution does not
162163
provide them). By default, libraries marked with an X are required if
163164
X11 is being used.
164165

165-
libXaw3d https://directory.fsf.org/project/xaw3d/
166-
X libxpm for XPM: http://www.x.org/releases/current/src/lib/
166+
libXaw3d https://directory.fsf.org/project/Xaw3d
167+
X libxpm for XPM: https://www.x.org/releases/current/src/lib/
167168
X libpng for PNG: http://www.libpng.org/
168-
libz (for PNG): http://www.zlib.net/
169-
X libjpeg for JPEG: http://www.ijg.org/
170-
X libtiff for TIFF: http://www.remotesensing.org/libtiff/
171-
X libgif for GIF: http://sourceforge.net/projects/giflib/
172-
librsvg2 for SVG: http://wiki.gnome.org/action/show/Projects/LibRsvg
169+
libz (for PNG): https://www.zlib.net/
170+
X libjpeg for JPEG: https://www.ijg.org/
171+
X libtiff for TIFF: http://www.simplesystems.org/libtiff/
172+
X libgif for GIF: http://giflib.sourceforge.net/
173+
librsvg2 for SVG: https://wiki.gnome.org/Projects/LibRsvg
173174

174175
If you supply the appropriate --without-LIB option, 'configure' will
175176
omit the corresponding library from Emacs, even if that makes for a
@@ -213,7 +214,7 @@ DETAILED BUILDING AND INSTALLATION:
213214
see nextstep/INSTALL. For non-ancient versions of MS Windows, see
214215
the file nt/INSTALL. For MS-DOS and MS Windows 3.X, see msdos/INSTALL.)
215216

216-
1) See the basic installation summary above for the disk space requirements.
217+
1) See BASIC INSTALLATION above for getting and configuring Emacs.
217218

218219
2) In the unlikely event that 'configure' does not detect your system
219220
type correctly, consult './etc/MACHINES' to see what --host, --build
@@ -352,7 +353,7 @@ Use --enable-link-time-optimization to enable link-time optimization.
352353
With GCC, you need GCC 4.5.0 and later, and 'configure' arranges for
353354
linking to be parallelized if possible. With Clang, you need GNU
354355
binutils with the gold linker and plugin support, along with the LLVM
355-
gold plugin <http://llvm.org/docs/GoldPlugin.html>. Link time
356+
gold plugin <https://llvm.org/docs/GoldPlugin.html>. Link time
356357
optimization is not the default as it tends to cause crashes and to
357358
make Emacs slower.
358359

Makefile.in

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -950,17 +950,15 @@ extraclean: $(extraclean_dirs:=_extraclean)
950950
TAGS tags: lib lib-src # src
951951
$(MAKE) -C src tags
952952

953-
.PHONY: have-tests
954-
have-tests:
955-
@if test ! -d test; then \
956-
echo "You do not seem to have the test/ directory."; \
957-
echo "Maybe you are using a release tarfile, rather than a repository checkout."; \
958-
exit 1; \
959-
fi
960-
961-
.PHONY: check check-maybe check-expensive check-all
962-
check check-maybe check-expensive check-all: have-tests all
953+
CHECK_TARGETS = check check-maybe check-expensive check-all
954+
.PHONY: $(CHECK_TARGETS)
955+
$(CHECK_TARGETS): all
956+
ifeq ($(wildcard test),test)
963957
$(MAKE) -C test $@
958+
else
959+
@echo "You do not seem to have the test/ directory."
960+
@echo "Maybe you used a release tarfile that lacks tests."
961+
endif
964962

965963
dist:
966964
cd ${srcdir}; ./make-dist

doc/emacs/arevert-xtra.texi

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
@c
55
@c This file is included either in emacs-xtra.texi (when producing the
66
@c printed version) or in the main Emacs manual (for the on-line version).
7-
@node Autorevert
8-
@section Auto Reverting Non-File Buffers
7+
8+
@node Non-File Buffers
9+
@subsection Auto Reverting Non-File Buffers
910

1011
Global Auto Revert Mode normally only reverts file buffers. There are
1112
two ways to auto-revert certain non-file buffers: by enabling Auto
@@ -43,7 +44,7 @@ explained in the corresponding sections.
4344
@end menu
4445

4546
@node Auto Reverting the Buffer Menu
46-
@subsection Auto Reverting the Buffer Menu
47+
@subsubsection Auto Reverting the Buffer Menu
4748

4849
If auto-reverting of non-file buffers is enabled, the Buffer Menu
4950
@iftex
@@ -65,7 +66,7 @@ adding marks sets the buffer's modified flag prevents Auto Revert from
6566
automatically erasing the marks.
6667

6768
@node Auto Reverting Dired
68-
@subsection Auto Reverting Dired buffers
69+
@subsubsection Auto Reverting Dired buffers
6970

7071
Dired buffers only auto-revert when the file list of the buffer's main
7172
directory changes (e.g., when a new file is added or deleted). They

doc/emacs/buffers.texi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -568,10 +568,10 @@ mode in this buffer, as long as it is not marked modified. Global
568568
Auto Revert mode applies to the @file{*Buffer List*} buffer only if
569569
@code{global-auto-revert-non-file-buffers} is non-@code{nil}.
570570
@iftex
571-
@inforef{Autorevert,, emacs-xtra}, for details.
571+
@inforef{Auto Reverting the Buffer Menu,, emacs-xtra}, for details.
572572
@end iftex
573573
@ifnottex
574-
@xref{Autorevert, global-auto-revert-non-file-buffers}, for details.
574+
@xref{Auto Reverting the Buffer Menu, global-auto-revert-non-file-buffers}, for details.
575575
@end ifnottex
576576

577577
@node Indirect Buffers

doc/emacs/cmdargs.texi

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ corresponding long form.
3939

4040
The long forms with @samp{--} are easier to remember, but longer to
4141
type. However, you don't have to spell out the whole option name; any
42-
unambiguous abbreviation is enough. When a long option takes an
42+
unambiguous abbreviation is enough. When a long option requires an
4343
argument, you can use either a space or an equal sign to separate the
4444
option name and the argument. Thus, for the option @samp{--display},
4545
you can write either @samp{--display sugar-bombs:0.0} or
@@ -347,13 +347,15 @@ Start Emacs with minimum customizations. This is similar to using
347347
@itemx --bg-daemon[=@var{name}]
348348
@itemx --fg-daemon[=@var{name}]
349349
Start Emacs as a daemon: after Emacs starts up, it starts the Emacs
350-
server without opening any frames.
351-
(Optionally, you can specify an explicit @var{name} for the server.)
352-
You can then use the @command{emacsclient} command to connect to Emacs
353-
for editing. @xref{Emacs Server}, for information about using Emacs
354-
as a daemon. A ``background'' daemon disconnects from the terminal
355-
and runs in the background (@samp{--daemon} is an alias for
356-
@samp{--bg-daemon}).
350+
server without opening any frames. You can then use the
351+
@command{emacsclient} command to connect to Emacs for editing.
352+
(Optionally, you can specify an explicit @var{name} for the server; if
353+
you do, you will need to specify the same @var{name} when you invoke
354+
@command{emacsclient}, via its @option{--socket-name} option, see
355+
@ref{emacsclient Options}.) @xref{Emacs Server}, for information
356+
about using Emacs as a daemon. A ``background'' daemon disconnects
357+
from the terminal and runs in the background (@samp{--daemon} is an
358+
alias for @samp{--bg-daemon}).
357359

358360
@item --no-desktop
359361
@opindex --no-desktop

doc/emacs/display.texi

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1141,6 +1141,55 @@ right-to-left paragraphs.
11411141
@node Displaying Boundaries
11421142
@section Displaying Boundaries
11431143

1144+
@cindex mode, display-fill-column-indicator
1145+
@findex display-fill-column-indicator-mode
1146+
@findex global-display-fill-column-indicator-mode
1147+
Emacs can add an indicator to display a fill column position. The
1148+
fill column indicator is a useful functionality specially in
1149+
prog-mode to indicate the position of an specific column.
1150+
1151+
You can set the buffer-local variables @code{display-fill-column-indicator}
1152+
and @code{display-fill-column-indicator-character} to activate the
1153+
indicator and controls how the indicator looks.
1154+
1155+
Alternatively you can type @w{@kbd{M-x display-fill-column-indicator-mode}}
1156+
or @w{@kbd{M-x global-display-fill-column-indicator-mode}} which enables the
1157+
indicator locally and globally respectively and also chooses the
1158+
character to use if none is set already. It is possible to use the
1159+
first one to activate the indicator in a hook or the second one to
1160+
enable it globally.
1161+
1162+
There are 2 buffer local variables and 1 face to customize this mode:
1163+
1164+
@table @code
1165+
@item display-fill-column-indicator-column
1166+
@vindex display-fill-column-indicator-column
1167+
Specifies the column number where the indicator should be set. It can
1168+
take positive numerical values for the column or the special value
1169+
@code{t} which means that the variable @code{fill-column} will be
1170+
used.
1171+
1172+
Any other value disables the indicator. The default value is @code{t}.
1173+
1174+
@item display-fill-column-indicator-char
1175+
@vindex display-fill-column-indicator-char
1176+
Specifies the character used for the indicator. This character can be
1177+
any valid char including unicode ones if the actual font supports
1178+
them.
1179+
1180+
When the mode is enabled through the functions
1181+
@code{display-fill-column-indicator-mode} or
1182+
@code{global-display-fill-column-indicator-mode}, the initialization
1183+
functions check if this variable is @code{non-nil}, otherwise the
1184+
initialization tries to set it to U+2502 or @samp{|}.
1185+
1186+
@item fill-column-indicator
1187+
@vindex fill-column-indicator
1188+
Specifies the face used to display the indicator. It inherits its
1189+
default values from shadow but without background color. To change
1190+
the indicator color you need to set only the foreground color of this face.
1191+
@end table
1192+
11441193
@vindex indicate-buffer-boundaries
11451194
On graphical displays, Emacs can indicate the buffer boundaries in
11461195
the fringes. If you enable this feature, the first line and the last

doc/emacs/emacs-xtra.texi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ modify this GNU manual.''
5959
* Picture Mode:: Editing pictures made up of characters using
6060
the quarter-plane screen model.
6161
62-
* Autorevert:: Auto Reverting non-file buffers.
62+
* Non-File Buffers:: Auto Reverting non-file buffers.
6363
* Subdir Switches:: Subdirectory switches in Dired.
6464
* Advanced Calendar/Diary Usage:: Advanced Calendar/Diary customization.
6565
* Emerge:: A convenient way of merging two versions of a program.

doc/emacs/emacs.texi

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -443,9 +443,7 @@ File Handling
443443
* Visiting:: Visiting a file prepares Emacs to edit the file.
444444
* Saving:: Saving makes your changes permanent.
445445
* Reverting:: Reverting cancels all the changes not saved.
446-
@ifnottex
447-
* Autorevert:: Auto Reverting non-file buffers.
448-
@end ifnottex
446+
* Auto Revert:: Keeping buffers automatically up-to-date.
449447
* Auto Save:: Auto Save periodically protects against loss of data.
450448
* File Aliases:: Handling multiple names for one file.
451449
* Directories:: Creating, deleting, and listing file directories.

doc/emacs/files.texi

Lines changed: 45 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ on file directories.
2525
* Visiting:: Visiting a file prepares Emacs to edit the file.
2626
* Saving:: Saving makes your changes permanent.
2727
* Reverting:: Reverting cancels all the changes not saved.
28-
@ifnottex
29-
* Autorevert:: Auto Reverting non-file buffers.
30-
@end ifnottex
28+
* Auto Revert:: Keeping buffers automatically up-to-date.
3129
* Auto Save:: Auto Save periodically protects against loss of data.
3230
* File Aliases:: Handling multiple names for one file.
3331
* Directories:: Creating, deleting, and listing file directories.
@@ -955,29 +953,51 @@ revert it automatically if it has changed---provided the buffer itself
955953
is not modified. (If you have edited the text, it would be wrong to
956954
discard your changes.)
957955

956+
You can also tell Emacs to revert buffers automatically when their
957+
visited files change on disk; @pxref{Auto Revert}.
958+
959+
@node Auto Revert
960+
@section Auto Revert: Keeping buffers automatically up-to-date
958961
@cindex Global Auto Revert mode
959962
@cindex mode, Global Auto Revert
960963
@cindex Auto Revert mode
961964
@cindex mode, Auto Revert
962965
@findex global-auto-revert-mode
963966
@findex auto-revert-mode
964967
@findex auto-revert-tail-mode
965-
@vindex auto-revert-interval
966-
@vindex auto-revert-remote-files
968+
969+
A buffer can get out of sync with respect to its visited file on
970+
disk if that file is changed by another program. To keep it up to
971+
date, you can enable Auto Revert mode by typing @kbd{M-x auto-revert-mode}.
972+
This automatically reverts the buffer when its visited file changes on
973+
disk. To do the same for all file buffers, type
974+
@kbd{M-x global-auto-revert-mode} to enable Global Auto Revert mode.
975+
976+
Auto Revert will not revert a buffer if it has unsaved changes, or if
977+
its file on disk is deleted or renamed.
978+
979+
One use of Auto Revert mode is to ``tail'' a file such as a system
980+
log, so that changes made to that file by other programs are
981+
continuously displayed. To do this, just move the point to the end of
982+
the buffer, and it will stay there as the file contents change.
983+
However, if you are sure that the file will only change by growing at
984+
the end, use Auto Revert Tail mode instead
985+
(@code{auto-revert-tail-mode}). It is more efficient for this.
986+
Auto Revert Tail mode also works for remote files.
987+
967988
@vindex auto-revert-verbose
968-
You can also tell Emacs to revert buffers periodically. To do this
969-
for a specific buffer, enable the minor mode Auto-Revert mode by
970-
typing @kbd{M-x auto-revert-mode}. This automatically reverts the
971-
current buffer when its visited file changes on disk. To do the same
972-
for all file buffers, type @kbd{M-x global-auto-revert-mode} to enable
973-
Global Auto-Revert mode. These minor modes do not check or revert
974-
remote files, because that is usually too slow. This behavior can be
975-
changed by setting the variable @code{auto-revert-remote-files} to
976-
non-@code{nil}.
989+
When a buffer is auto-reverted, a message is generated. This can be
990+
suppressed by setting @code{auto-revert-verbose} to @code{nil}.
991+
992+
@vindex auto-revert-remote-files
993+
The Auto Revert modes do not check or revert remote files, because
994+
that is usually too slow. This behavior can be changed by setting the
995+
variable @code{auto-revert-remote-files} to non-@code{nil}.
977996

978997
@cindex file notifications
979998
@vindex auto-revert-use-notify
980-
By default, Auto-Revert mode works using @dfn{file notifications},
999+
@vindex auto-revert-interval
1000+
By default, Auto Revert mode works using @dfn{file notifications},
9811001
whereby changes in the filesystem are reported to Emacs by the OS.
9821002
You can disable use of file notifications by customizing the variable
9831003
@code{auto-revert-use-notify} to a @code{nil} value, then Emacs will
@@ -990,38 +1010,30 @@ default.
9901010

9911011
@vindex auto-revert-avoid-polling
9921012
@vindex auto-revert-notify-exclude-dir-regexp
993-
By default, Auto-Revert mode will poll files for changes
994-
periodically even when file notifications are used. Such polling is
995-
usually unnecessary, and turning it off may save power by relying on
996-
notifications only. To do so, set the variable
1013+
By default, Auto Revert mode will poll files for changes
1014+
periodically even when file notifications are used. Polling is
1015+
unnecessary in many cases, and turning it off may save power by
1016+
relying on notifications only. To do so, set the variable
9971017
@code{auto-revert-avoid-polling} to non-@code{nil}. However,
9981018
notification is ineffective on certain file systems; mainly network
9991019
file system on Unix-like machines, where files can be altered from
1000-
other machines. To force polling when
1020+
other machines. For such file systems, polling may be necessary.
1021+
To force polling when
10011022
@code{auto-revert-avoid-polling} is non-@code{nil}, set
10021023
@code{auto-revert-notify-exclude-dir-regexp} to match files that
10031024
should be excluded from using notification.
10041025

1005-
One use of Auto-Revert mode is to ``tail'' a file such as a system
1006-
log, so that changes made to that file by other programs are
1007-
continuously displayed. To do this, just move the point to the end of
1008-
the buffer, and it will stay there as the file contents change.
1009-
However, if you are sure that the file will only change by growing at
1010-
the end, use Auto-Revert Tail mode instead
1011-
(@code{auto-revert-tail-mode}). It is more efficient for this.
1012-
Auto-Revert Tail mode works also for remote files.
1013-
1014-
When a buffer is auto-reverted, a message is generated. This can be
1015-
suppressed by setting @code{auto-revert-verbose} to @code{nil}.
1016-
1017-
In Dired buffers (@pxref{Dired}), Auto-Revert mode refreshes the
1026+
In Dired buffers (@pxref{Dired}), Auto Revert mode refreshes the
10181027
buffer when a file is created or deleted in the buffer's directory.
10191028

10201029
@xref{VC Undo}, for commands to revert to earlier versions of files
10211030
under version control. @xref{VC Mode Line}, for Auto Revert
10221031
peculiarities when visiting files under version control.
10231032

10241033
@ifnottex
1034+
@menu
1035+
* Non-File Buffers:: Auto Reverting Non-File Buffers.
1036+
@end menu
10251037
@include arevert-xtra.texi
10261038
@end ifnottex
10271039

0 commit comments

Comments
 (0)