emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

emacs-27 229995b: Fix some Texinfo markup


From: Basil L. Contovounesios
Subject: emacs-27 229995b: Fix some Texinfo markup
Date: Wed, 17 Jun 2020 08:17:30 -0400 (EDT)

branch: emacs-27
commit 229995ba2cd9f6d0a749a38c106cbfbfd04119a8
Author: Basil L. Contovounesios <contovob@tcd.ie>
Commit: Basil L. Contovounesios <contovob@tcd.ie>

    Fix some Texinfo markup
    
    * doc/misc/gnus-faq.texi (FAQ 3-11):
    * doc/emacs/frames.texi (Tab Bars): Consistently use @var with
    lower-case metasyntactic variables and @minus instead of a dash.
    (Text-Only Mouse):
    * doc/emacs/files.texi (Auto Revert):
    * doc/emacs/misc.texi (emacsclient Options)
    (Embedded WebKit Widgets):
    * doc/lispref/control.texi (pcase Macro):
    * doc/lispref/debugging.texi (Backtraces):
    * doc/lispref/files.texi (Truenames):
    * doc/lispref/frames.texi (Management Parameters):
    * doc/lispref/os.texi (Time Calculations):
    * doc/lispref/text.texi (Parsing JSON):
    * doc/misc/efaq-w32.texi (Other versions of Emacs, Debugging)
    (Swap Caps NT, Printing, Bash, Developing with Emacs):
    * doc/misc/efaq.texi (New in Emacs 25):
    * doc/misc/emacs-gnutls.texi (Help For Users):
    * doc/misc/message.texi (Using S/MIME, Passphrase caching):
    * test/manual/etags/tex-src/gzip.texi (Overview): Use @. when a
    sentence in the middle of a paragraph ends with an upper-case letter
    as per "(texinfo) Ending a Sentence".
---
 doc/emacs/files.texi                |  2 +-
 doc/emacs/frames.texi               | 21 +++++++++++----------
 doc/emacs/misc.texi                 |  6 +++---
 doc/lispref/control.texi            |  2 +-
 doc/lispref/debugging.texi          |  2 +-
 doc/lispref/files.texi              |  2 +-
 doc/lispref/frames.texi             |  2 +-
 doc/lispref/os.texi                 |  2 +-
 doc/lispref/text.texi               |  2 +-
 doc/misc/efaq-w32.texi              | 14 +++++++-------
 doc/misc/efaq.texi                  |  2 +-
 doc/misc/emacs-gnutls.texi          |  2 +-
 doc/misc/gnus-faq.texi              |  5 +++--
 doc/misc/message.texi               |  4 ++--
 test/manual/etags/tex-src/gzip.texi |  2 +-
 15 files changed, 36 insertions(+), 34 deletions(-)

diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi
index b95203b..5998326 100644
--- a/doc/emacs/files.texi
+++ b/doc/emacs/files.texi
@@ -1003,7 +1003,7 @@ variable @code{auto-revert-remote-files} to 
non-@code{nil}.
 @vindex auto-revert-use-notify
 @vindex auto-revert-interval
   By default, Auto Revert mode works using @dfn{file notifications},
-whereby changes in the filesystem are reported to Emacs by the OS.
+whereby changes in the filesystem are reported to Emacs by the OS@.
 You can disable use of file notifications by customizing the variable
 @code{auto-revert-use-notify} to a @code{nil} value, then Emacs will
 check for file changes by polling every five seconds.  You can change
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 8f448e1..e0eabe3 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1362,15 +1362,16 @@ a recently used tab.
 @findex tab-next
 Switch to the next tab.  If you repeat this command, it cycles through
 all the tabs on the selected frame.  With a positive numeric argument
-N, it switches to the next Nth tab; with a negative argument −N, it
-switches back to the previous Nth tab.
+@var{n}, it switches to the next @var{n}th tab; with a negative
+argument @minus{}@var{n}, it switches back to the previous @var{n}th
+tab.
 
 @item S-C-@key{TAB}
 @kindex S-C-TAB
 @findex tab-previous
-Switch to the previous tab.  With a positive numeric argument N, it
-switches to the previous Nth tab; with a negative argument −N, it
-switches back to the next Nth tab.
+Switch to the previous tab.  With a positive numeric argument @var{n},
+it switches to the previous @var{n}th tab; with a negative argument
+@minus{}@var{n}, it switches back to the next @var{n}th tab.
 
 @item C-x t @key{RET} @var{tabname} @key{RET}
 Switch to the tab by its name, with completion on all tab names.
@@ -1392,7 +1393,7 @@ to select the tab by its number.
 @findex tab-recent
 Switch to the recent tab.  The key combination is the modifier key
 defined by @code{tab-bar-select-tab-modifiers} and the key @kbd{0}.
-With a numeric argument N, switch to the Nth recent tab.
+With a numeric argument @var{n}, switch to the @var{n}th recent tab.
 @end table
 
   The following commands can be used to operate on tabs:
@@ -1406,9 +1407,9 @@ variable @code{tab-bar-tab-name-function}.
 
 @item C-x t m
 @findex tab-move
-Move the current tab N positions to the right with a positive numeric
-argument N.  With a negative argument −N, move the current tab
-N positions to the left.
+Move the current tab @var{n} positions to the right with a positive
+numeric argument @var{n}.  With a negative argument @minus{}@var{n},
+move the current tab @var{n} positions to the left.
 @end table
 
 @findex tab-bar-history-mode
@@ -1621,7 +1622,7 @@ again.
 enable mouse support.  You must have the gpm server installed and
 running on your system in order for this to work.  Note that when
 this mode is enabled, you cannot use the mouse to transfer text
-between Emacs and other programs which use GPM.  This is due to
+between Emacs and other programs which use GPM@.  This is due to
 limitations in GPM and the Linux kernel.
 
 @iftex
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi
index 47f195d..2f02c70 100644
--- a/doc/emacs/misc.texi
+++ b/doc/emacs/misc.texi
@@ -1968,12 +1968,12 @@ evaluate, @emph{not} as a list of files to visit.
 @item -f @var{server-file}
 @itemx --server-file=@var{server-file}
 Specify a server file (@pxref{TCP Emacs server}) for connecting to an
-Emacs server via TCP.  Alternatively, you can set the
+Emacs server via TCP@.  Alternatively, you can set the
 @env{EMACS_SERVER_FILE} environment variable to point to the server
 file.  (The command-line option overrides the environment variable.)
 
 An Emacs server usually uses a local socket to listen for connections,
-but also supports connections over TCP.  To connect to a TCP Emacs
+but also supports connections over TCP@.  To connect to a TCP Emacs
 server, @command{emacsclient} needs to read a @dfn{server file}
 containing the connection details of the Emacs server.  The name of
 this file is specified with this option, either as a file name
@@ -2882,7 +2882,7 @@ widget.  The URL normally defaults to the URL at or 
before point, but
 if there is an active region (@pxref{Mark}), the default URL comes
 from the region instead, after removing any whitespace from it.  The
 command then creates a new buffer with the embedded browser showing
-the specified URL.  The buffer is put in the Xwidget-WebKit mode
+the specified URL@.  The buffer is put in the Xwidget-WebKit mode
 (similar to Image mode, @pxref{Image Mode}), which provides
 one-key commands for scrolling the widget, changing its size, and
 reloading it.  Type @w{@kbd{C-h b}} in that buffer to see the key
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index 58f9336..01ae94e 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -835,7 +835,7 @@ the second and subsequent occurrences do not expand to 
re-binding,
 but instead expand to an equality test using @code{eq}.
 
 The following example features a @code{pcase} form
-with two clauses and two @var{seqpat}, A and B.
+with two clauses and two @var{seqpat}, A and B@.
 Both A and B first check that @var{expval} is a
 pair (using @code{pred}),
 and then bind symbols to the @code{car} and @code{cdr}
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 24ec656..29a0ab7 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -402,7 +402,7 @@ assumptions are false if the debugger is running 
interpreted.
 @cindex backtrace buffer
 
 Debugger mode is derived from Backtrace mode, which is also used to
-show backtraces by Edebug and ERT.  (@pxref{Edebug}, and @ref{Top,the
+show backtraces by Edebug and ERT@.  (@pxref{Edebug}, and @ref{Top,the
 ERT manual,, ert, ERT: Emacs Lisp Regression Testing}.)
 
 @cindex stack frame
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index bdda59f..6ca2834 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1190,7 +1190,7 @@ inconclusive, the function returns @code{t} on Cygwin and 
@code{nil}
 on macOS.
 
 Currently this function always returns @code{nil} on platforms other
-than MS-DOS, MS-Windows, Cygwin, and macOS.  It does not detect
+than MS-DOS, MS-Windows, Cygwin, and macOS@.  It does not detect
 case-insensitivity of mounted filesystems, such as Samba shares or
 NFS-mounted Windows volumes.  On remote hosts, it assumes @code{t} for
 the @samp{smb} method.  For all other connection methods, runtime
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 26546ab..7b37472 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -2173,7 +2173,7 @@ it on an undecorated frame.
 @item override-redirect
 @cindex override redirect frames
 If non-@code{nil}, this means that this is an @dfn{override redirect}
-frame---a frame not handled by window managers under X.  Override
+frame---a frame not handled by window managers under X@.  Override
 redirect frames have no window manager decorations, can be positioned
 and resized only via Emacs' positioning and resizing functions and are
 usually drawn on top of all other frames.  Setting this parameter has
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index d600916..1c3be1c 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -1988,7 +1988,7 @@ The result is @code{nil} if either argument is a NaN.
 This returns the time difference @var{t1} @minus{} @var{t2} between
 two time values, as a Lisp time value.  The result is exact and its clock
 resolution is no worse than the worse of its two arguments' resolutions.
-The result is floating-point only if it is infinite or a NaN.
+The result is floating-point only if it is infinite or a NaN@.
 If you need the difference in units
 of elapsed seconds, you can convert it with @code{time-convert} or
 @code{float-time}.  @xref{Time Conversion}.
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 0bbb0aa..5d83e7b 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -5216,7 +5216,7 @@ Signaled when encountering invalid JSON syntax.
 @end table
 
   Only top-level values (arrays and objects) can be serialized to
-JSON.  The subobjects within these top-level values can be of any
+JSON@.  The subobjects within these top-level values can be of any
 type.  Likewise, the parsing functions will only return vectors,
 hashtables, alists, and plists.
 
diff --git a/doc/misc/efaq-w32.texi b/doc/misc/efaq-w32.texi
index 83dd176..bbfc86b 100644
--- a/doc/misc/efaq-w32.texi
+++ b/doc/misc/efaq-w32.texi
@@ -143,7 +143,7 @@ executable, using the MinGW GCC compiler and development 
tools.
 
 @cindex DOS port
 @cindex Windows 3.11 port
-Emacs can also be compiled for MSDOS.  When run on recent MS Windows,
+Emacs can also be compiled for MSDOS@.  When run on recent MS Windows,
 it supports long file names, and uses the Windows clipboard.
 See the @file{msdos} directory in the Emacs sources for building
 instructions (requires DJGPP).
@@ -222,7 +222,7 @@ specific notes about debugging Emacs.
 
 @cindex debugging Emacs with GDB
 GDB is the GNU debugger, which can be used to debug Emacs when it has
-been compiled with MinGW GCC.  The best results will be obtained if
+been compiled with MinGW GCC@.  The best results will be obtained if
 you start gdb from the @file{src} directory as @kbd{gdb ./emacs.exe}.
 This will load the init file @file{.gdbinit}@footnote{
 Latest versions of GDB might refuse to load the init file for security
@@ -592,7 +592,7 @@ Subject: Re: Re[2]: problem with caps/ctrl swap on NT 4.0
 @end ignore
 @smallexample
 It's a binary value that lets you map keystrokes in the low-level keyboard
-drivers in NT.  As a result you don't have to worry about applications
+drivers in NT@.  As a result you don't have to worry about applications
 bypassing mappings that you've done at a higher level (i.e., it just works).
 
 Here's the format of the value:
@@ -1187,7 +1187,7 @@ A lot of effort has gone into making it easier to print 
from Emacs on
 MS Windows, but this has still been insufficient to keep up with
 changes in printing technology from text and postscript based printers
 connected via ports that can be accessed directly, to graphical
-printers that are only accessible via USB.  For details, see
+printers that are only accessible via USB@.  For details, see
 @uref{http://www.emacswiki.org/emacs/PrintingFromEmacs, Emacs
 Wiki}, @uref{http://www.emacswiki.org/emacs/PrintWithWebBrowser}, and
 @uref{http://www.emacswiki.org/emacs/PrintFromWindowsExplorer}.
@@ -1398,7 +1398,7 @@ default shell in Emacs, you can place the following in 
your init file:
 @end example
 
 WARNING: Some versions of bash set and use the environment variable
-PID.  For some as yet unknown reason, if @env{PID} is set and Emacs
+PID@.  For some as yet unknown reason, if @env{PID} is set and Emacs
 passes it on to bash subshells, bash dies (Emacs can inherit the
 @env{PID} variable if it's started from a bash shell).  If you clear
 the @env{PID} variable in your init file, you should be able to
@@ -1890,9 +1890,9 @@ need to use.
 @node MSVC
 @section How do I use Emacs with Microsoft Visual C++
 
-There are two ways you can use Emacs in conjunction with MSVC.  You
+There are two ways you can use Emacs in conjunction with MSVC@.  You
 can use Emacs as the editor, and do everything else in the DevStudio
-IDE.  Or you can use Emacs as an IDE, calling the MSVC command line
+IDE@.  Or you can use Emacs as an IDE, calling the MSVC command line
 tools to build your project.
 
 @menu
diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi
index 132e8ff..b2ed60b 100644
--- a/doc/misc/efaq.texi
+++ b/doc/misc/efaq.texi
@@ -1125,7 +1125,7 @@ scanning of @code{#define}d symbols.
 
 @cindex xref
 @item
-New package Xref replaces Etags's front-end and UI.  Xref provides a
+New package Xref replaces Etags's front-end and UI@.  Xref provides a
 generic framework and new commands to find and move to definitions of
 functions, macros, data structures etc., as well as go back to the
 location where you were before moving to a definition.  It supersedes
diff --git a/doc/misc/emacs-gnutls.texi b/doc/misc/emacs-gnutls.texi
index 555a4b1..7c57cc0 100644
--- a/doc/misc/emacs-gnutls.texi
+++ b/doc/misc/emacs-gnutls.texi
@@ -134,7 +134,7 @@ order: @file{/etc/ssl/certs/ca-certificates.crt} for 
Debian, Ubuntu,
 Gentoo and Arch Linux; @file{/etc/pki/tls/certs/ca-bundle.crt} for
 Fedora and RHEL; @file{/etc/ssl/ca-bundle.pem} for Suse;
 @file{/usr/ssl/certs/ca-bundle.crt} for Cygwin;
-@file{/usr/local/share/certs/ca-root-nss.crt} for FreeBSD.  You can
+@file{/usr/local/share/certs/ca-root-nss.crt} for FreeBSD@.  You can
 easily customize @code{gnutls-trustfiles} to be something else, but
 let us know if you do, so we can make the change to benefit the other
 users of that platform.
diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi
index fd28539..9c1d2d0 100644
--- a/doc/misc/gnus-faq.texi
+++ b/doc/misc/gnus-faq.texi
@@ -689,8 +689,9 @@ retrieves via POP3?
 @subsubheading Answer
 
 Yes, if the POP3 server supports the UIDL control (maybe almost servers
-do it nowadays).  To do that, add a @code{:leave VALUE} pair to each
-POP3 mail source.  @xref{Mail Source Specifiers}, for details on VALUE.
+do it nowadays).  To do that, add a @code{:leave @var{value}} pair to
+each POP3 mail source.  @xref{Mail Source Specifiers}, for details on
+@var{value}.
 
 @node FAQ 4 - Reading messages
 @subsection Reading messages
diff --git a/doc/misc/message.texi b/doc/misc/message.texi
index f9527ee..bdd31b1 100644
--- a/doc/misc/message.texi
+++ b/doc/misc/message.texi
@@ -1116,7 +1116,7 @@ is used.
 
 The choice between EasyPG and OpenSSL is controlled by the variable
 @code{mml-smime-use}, which needs to be set to the value @code{epg}
-for EasyPG.  Depending on your version of Emacs that value may be the
+for EasyPG@.  Depending on your version of Emacs that value may be the
 default; if not, you can either customize that variable or place the
 following line in your @file{.emacs} file (that line needs to be
 placed above other code related to message/gnus/encryption):
@@ -1232,7 +1232,7 @@ decryption/sign operation.  @xref{Agent Options, , , 
gnupg, Using the
 GNU Privacy Guard}.
 
 How to use @command{gpg-agent} in Emacs depends on your version of
-GnuPG.  With GnuPG version 2.1, @command{gpg-agent} is started
+GnuPG@.  With GnuPG version 2.1, @command{gpg-agent} is started
 automatically if necessary.  With older versions you may need to run
 the following command from the shell before starting Emacs.
 
diff --git a/test/manual/etags/tex-src/gzip.texi 
b/test/manual/etags/tex-src/gzip.texi
index ea5f7f5..72c5c7e 100644
--- a/test/manual/etags/tex-src/gzip.texi
+++ b/test/manual/etags/tex-src/gzip.texi
@@ -148,7 +148,7 @@ input and writes the uncompressed data on standard output.  
@code{zcat}
 will uncompress files that have the correct magic number whether they
 have a @samp{.gz} suffix or not.
 
-@code{gzip} uses the Lempel-Ziv algorithm used in @code{zip} and PKZIP.
+@code{gzip} uses the Lempel-Ziv algorithm used in @code{zip} and PKZIP@.
 The amount of compression obtained depends on the size of the input and
 the distribution of common substrings.  Typically, text such as source
 code or English is reduced by 60-70%.  Compression is generally much



reply via email to

[Prev in Thread] Current Thread [Next in Thread]