Skip to content

Commit

Permalink
Tweaks.
Browse files Browse the repository at this point in the history
git-svn-id: https://svn.r-project.org/R/trunk@85908 00db46b3-68df-0310-9c12-caf00c1e9a41
  • Loading branch information
hornik committed Feb 15, 2024
1 parent 7013e66 commit 790c46a
Show file tree
Hide file tree
Showing 74 changed files with 283 additions and 224 deletions.
120 changes: 60 additions & 60 deletions doc/NEWS.Rd

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions src/library/base/man/Memory-limits.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
}
\section{Unix}{
The address-space limit is system-specific: 32-bit OSes
imposes a limit of no more than 4Gb: it is often 3Gb. Running
imposes a limit of no more than 4\abbr{Gb}: it is often 3\abbr{Gb}. Running
32-bit executables on a 64-bit OS will have similar limits: 64-bit
executables will have an essentially infinite system-specific limit
(e.g., 128Tb for Linux on x86_64 CPUs).
Expand All @@ -62,21 +62,21 @@
\preformatted{limit cputime 10m
limit vmemoryuse 4096m
}
to limit a process to 10 minutes of CPU time and (around) 4Gb of
to limit a process to 10 minutes of CPU time and (around) 4\abbr{Gb} of
virtual memory. (There are other options to set the RAM in use, but they
are not generally honoured.)
}
\section{Windows}{
The address-space limit is 2Gb under 32-bit Windows unless the OS's
default has been changed to allow more (up to 3Gb). See
The address-space limit is 2\abbr{Gb} under 32-bit Windows unless the OS's
default has been changed to allow more (up to 3\abbr{Gb}). See
\url{https://docs.microsoft.com/en-gb/windows/desktop/Memory/physical-address-extension}
and
\url{https://docs.microsoft.com/en-gb/windows/desktop/Memory/4-gigabyte-tuning}.
Under most 64-bit versions of Windows the limit for a 32-bit build
of \R is 4Gb: for the oldest ones it is 2Gb. The limit for a 64-bit
of \R is 4\abbr{Gb}: for the oldest ones it is 2\abbr{Gb}. The limit for a 64-bit
build of \R (imposed by the OS) is 8Tb.
It is not normally possible to allocate as much as 2Gb to a single
It is not normally possible to allocate as much as 2\abbr{Gb} to a single
vector in a 32-bit build of \R even on 64-bit Windows because of
preallocations by Windows in the middle of the address space.
}
Expand Down
2 changes: 1 addition & 1 deletion src/library/base/man/Quotes.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
also supported when reading character strings by \code{\link{scan}}
and \code{\link{read.table}} if \code{allowEscapes = TRUE}. Unicode
escapes can be used to enter Unicode characters not in the current
locale's charset (when the string will be stored internally in UTF-8).
locale's \abbr{charset} (when the string will be stored internally in UTF-8).
The maximum allowed value for \samp{\\nnn} is \samp{\\377} (the same
character as \samp{\\xff}).
Expand Down
2 changes: 1 addition & 1 deletion src/library/base/man/Sys.glob.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Sys.glob(paths, dirmark = FALSE)
File paths in Windows are interpreted with separator \code{\\} or
\code{/}. Paths with a drive but relative (such as \code{c:foo\\bar})
are tricky, but an attempt is made to handle them correctly. An
attempt is made to handle UNC paths starting with a double
attempt is made to handle \abbr{UNC} paths starting with a double
backslash. UTF-8-encoded paths not valid in the current locale can be
used.
#endif
Expand Down
6 changes: 4 additions & 2 deletions src/library/base/man/UTF8filepaths.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 2019 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{UTF8filepaths}
\alias{file path encoding}
\alias{UTF-8 file path}
Expand All @@ -11,7 +13,7 @@
\description{
Most modern file systems store file-path components (names of
directories and files) in a character encoding of wide scope: usually
UTF-8 on a Unix-alike and UCS-2/UTF-16 on Windows. However, this was
UTF-8 on a Unix-alike and \I{UCS-2}/UTF-16 on Windows. However, this was
not true when \R was first developed and there are still exceptions
amongst file systems, e.g.\sspace{}FAT32.

Expand Down Expand Up @@ -55,7 +57,7 @@
\section{Windows}{
Windows provides proprietary entry points to access its file systems,
and these gained \sQuote{wide} versions in Windows NT that allowed
file paths in UCS-2/UTF-16 to be accessed from any locale.
file paths in \I{UCS-2}/UTF-16 to be accessed from any locale.

Some \R functions use these entry points when file paths are marked
as Latin-1 or UTF-8 to allow access to paths not in the current
Expand Down
4 changes: 3 additions & 1 deletion src/library/base/man/browserText.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 1995-2011 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{browserText}
\alias{browserText}
\alias{browserCondition}
Expand Down Expand Up @@ -39,7 +41,7 @@ stack and call \code{browserSetDebug} with \code{n} set to that value.
Then, by typing \code{c} at the browser prompt you will cause evaluation
to continue, and provided there are no intervening calls to browser or
other interrupts, control will halt again once evaluation has returned to
the closure specified. This is similar to the up functionality in gdb
the closure specified. This is similar to the up functionality in \I{GDB}
or the "step out" functionality in other debuggers.
}
\value{
Expand Down
4 changes: 2 additions & 2 deletions src/library/base/man/connections.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ socketTimeout(socket, timeout = -1)
\code{description} which is marked as being in UTF-8 is passed to
Windows as a \sQuote{wide} character string. This allows files with
names not in the native encoding to be opened on file systems which
use Unicode file names (such as NTFS but not FAT32).
use Unicode file names (such as \abbr{NTFS} but not FAT32).
}
\section{\samp{ftp://} URLs}{
Expand Down Expand Up @@ -606,7 +606,7 @@ socketTimeout(socket, timeout = -1)
on macOS (and Solaris) but 1024 on Linux. The limit can be raised in the
shell used to launch \R, for example by \command{ulimit -n}.) File
descriptors are used for many other purposes including dynamically
loading DSO/DLLs (see \code{\link{dyn.load}}) which may use up to 60\%
loading \abbr{DSO}/DLLs (see \code{\link{dyn.load}}) which may use up to 60\%
of the limit.
Windows has a default limit of 512 open C file streams: these are used
Expand Down
8 changes: 5 additions & 3 deletions src/library/base/man/dynload.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 1995-2023 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{dyn.load}
\alias{dyn.load}
\alias{dyn.unload}
Expand Down Expand Up @@ -64,7 +66,7 @@ is.loaded(symbol, PACKAGE = "", type = "")
loadable libraries} (abbreviated to \sQuote{DLL}) on all platforms
except macOS, which uses the term for a different sort
of object. On Unix-alikes they are also called \sQuote{dynamic
shared objects} (\sQuote{DSO}), or \sQuote{shared objects} for
shared objects} (\sQuote{\abbr{DSO}}), or \sQuote{shared objects} for
short. (The POSIX standards use \sQuote{executable object file},
but no one else does.)

Expand Down Expand Up @@ -202,7 +204,7 @@ is.loaded(symbol, PACKAGE = "", type = "")
search order for where a DLL is found (if not given as an absolute
path, which is preferred), \emph{and} of where its dependent DLLs will
be found. This search path depends on the version of Windows and its
security settings, but for versions since Windows XP SP1 it is
security settings, but for versions since \I{Windows XP SP1} it is
\itemize{
\item The directory from which the application was launched.
\item The various system directories,
Expand All @@ -218,7 +220,7 @@ is.loaded(symbol, PACKAGE = "", type = "")
(\code{\link{library.dynam}} does that automatically in recent
versions of \R), but the DLL search order means that DLLs in the
launch directory and in system directories will be preferred. On
Windows XP SP1 and later there is a way to modify the search order.
\I{Windows XP SP1} and later there is a way to modify the search order.
If argument \code{DLLpath} is supplied to \code{dyn.load}, the latter
makes use of the Windows system call \code{SetDllDirectory} to insert
the value of \code{DLLpath} in second place, and removes the current
Expand Down
4 changes: 2 additions & 2 deletions src/library/base/man/file.info.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ file.size(\dots)
On most systems symbolic links are followed, so information is given
about the file to which the link points rather than about the link.}
\item{On Windows:}{
File modes are probably only useful on NTFS file systems, and it seems
File modes are probably only useful on \abbr{NTFS} file systems, and it seems
all three digits refer to the file's owner.
The execute/search bits are set for directories, and for files based
on their extensions (e.g., \file{.exe}, \file{.com}, \file{.cmd}
Expand Down Expand Up @@ -113,7 +113,7 @@ file.size(\dots)
convenience wrappers returning just one of the columns.
}
\note{
Some (now old) unix alike systems allow files of more than 2Gb to be created but
Some (now old) unix alike systems allow files of more than 2\abbr{Gb} to be created but
not accessed by the \code{stat} system call. Such files may show up
as non-readable (and very likely not be readable by any of \R's input
functions).
Expand Down
8 changes: 4 additions & 4 deletions src/library/base/man/files.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Sys.junction(from, to)
\code{to} argument can specify a single existing directory. If
\code{copy.mode = TRUE} file read/write/execute permissions are copied
where possible, restricted by \sQuote{\link{umask}}. (On Windows this
applies only to files.) Other security attributes such as ACLs are not
applies only to files.) Other security attributes such as \abbr{ACL}s are not
copied. On a POSIX filesystem the targets of symbolic links will be
copied rather than the links themselves, and hard links are copied
separately. Using \code{copy.date = TRUE} may or may not copy the
Expand All @@ -126,9 +126,9 @@ Sys.junction(from, to)
on those file systems which support them. For \code{file.symlink} the
\code{to} argument can specify a single existing directory. (Unix and
macOS native filesystems support both. Windows has hard links to
files on NTFS file systems and concepts related to symbolic links on
files on \abbr{NTFS} file systems and concepts related to symbolic links on
recent versions: see the section below on the Windows version of this
help page. What happens on a FAT or SMB-mounted file system is OS-specific.)
help page. What happens on a FAT or \abbr{SMB}-mounted file system is OS-specific.)

File arguments with a marked encoding (see \code{\link{Encoding}} are
if possible translated to the native encoding, except on Windows where
Expand Down Expand Up @@ -171,7 +171,7 @@ Sys.junction(from, to)
}

\section{Symbolic links on Windows}{ Symbolic links in the sense of
POSIX file systems do not exist on Windows: however, NTFS file systems
POSIX file systems do not exist on Windows: however, \abbr{NTFS} file systems
support two similar concepts.

There are \sQuote{junctions} (or \sQuote{junction points}),
Expand Down
2 changes: 1 addition & 1 deletion src/library/base/man/files2.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Sys.umask(mode = NA)
file. So \R interprets \code{mode} to mean set read-only if and only
if \code{(mode & 0200) == 0} (interpreted in octal). Windows has a much
more extensive system of file permissions on some file systems
(e.g., versions of NTFS) which are unrelated to this system call.
(e.g., versions of \abbr{NTFS}) which are unrelated to this system call.
#endif
\code{Sys.umask} sets the \code{umask} and returns the previous value:
Expand Down
6 changes: 3 additions & 3 deletions src/library/base/man/gc.time.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@
\title{Report Time Spent in Garbage Collection}
\description{
This function reports the time spent in garbage collection so far in
the \R session while GC timing was enabled.
the \R session while \abbr{GC} timing was enabled.
}
\usage{
gc.time(on = TRUE)
}
\arguments{
\item{on}{logical; if \code{TRUE}, GC timing is enabled.}
\item{on}{logical; if \code{TRUE}, \abbr{GC} timing is enabled.}
}
\value{
A numerical vector of length 5 giving the user CPU time, the system
CPU time, the elapsed time and children's user and system CPU times
(normally both zero), of time spent doing garbage collection whilst
GC timing was enabled.
\abbr{GC} timing was enabled.
Times of child processes are not available on Windows and will always
be given as \code{NA}.
Expand Down
12 changes: 6 additions & 6 deletions src/library/base/man/gctorture.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ gctorture2(step, wait = step, inhibit_release = FALSE)
}
\arguments{
\item{on}{logical; turning it on/off.}
\item{step}{integer; run GC every \code{step} allocations; \code{step
= 0} turns the GC torture off.}
\item{step}{integer; run \abbr{GC} every \code{step} allocations; \code{step
= 0} turns the \abbr{GC} torture off.}
\item{wait}{integer; number of allocations to wait before starting
GC torture.}
\abbr{GC} torture.}
\item{inhibit_release}{logical; do not release free objects for
re-use: use with caution.}
}
Expand All @@ -30,9 +30,9 @@ gctorture2(step, wait = step, inhibit_release = FALSE)
}
\details{
Calling \code{gctorture(TRUE)} instructs the memory manager to force a
full GC on every allocation. \code{gctorture2} provides a more refined
interface that allows the start of the GC torture to be deferred and
also gives the option of running a GC only every \code{step}
full \abbr{GC} on every allocation. \code{gctorture2} provides a more refined
interface that allows the start of the \abbr{GC} torture to be deferred and
also gives the option of running a \abbr{GC} only every \code{step}
allocations.

The third argument to \code{gctorture2} is only used if R has been
Expand Down
4 changes: 2 additions & 2 deletions src/library/base/man/gettext.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,12 @@ Sys.setLanguage(lang, unset = "en")
name: your system may have a \command{man} page for it. With a
non-\code{NULL} \code{dirname} it specifies where to look for message
catalogues: with \code{dirname = NULL} it returns the current location.
If NLS is not enabled, \code{bindtextdomain(*,*)} returns \code{NULL}.
If \abbr{NLS} is not enabled, \code{bindtextdomain(*,*)} returns \code{NULL}.
%%
The special case \code{bindtextdomain(NULL)} calls C level
\code{textdomain(textdomain(NULL))} for the purpose of flushing (i.e.,
emptying) the cache of already translated strings; it returns \code{TRUE}
when NLS is enabled.
when \abbr{NLS} is enabled.
The utility \code{Sys.setlanguage(lang)} combines setting the
\env{LANGUAGE} environment variable with flushing the translation cache
Expand Down
4 changes: 3 additions & 1 deletion src/library/base/man/iconv.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 1995-2023 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{iconv}
\alias{iconv}
\alias{iconvlist}
Expand Down Expand Up @@ -135,7 +137,7 @@ iconvlist()

Encodings using character units which are more than one byte in size
can be written on a file in either big-endian or little-endian order:
this applies most commonly to UCS-2, UTF-16 and UTF-32/UCS-4
this applies most commonly to \I{UCS-2}, UTF-16 and UTF-32/\I{UCS-4}
encodings. Some systems will write the Unicode character
\code{U+FEFF} at the beginning of a file in these encodings and
perhaps also in UTF-8. In that usage the character is known as a \abbr{BOM},
Expand Down
6 changes: 4 additions & 2 deletions src/library/base/man/libcurlVersion.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 2015-2021 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{libcurlVersion}
\alias{libcurlVersion}
\title{
Expand Down Expand Up @@ -50,9 +52,9 @@ libcurlVersion()
\url{https://curl.se/docs/ssl-compared.html} for more details on
\abbr{SSL} versions (the current standard being known as \abbr{TLS}). Normally
\code{libcurl} used with \R uses SecureTransport on macOS, OpenSSL on
Windows and GnuTLS, NSS or OpenSSL on Unix-alikes. (At the time of
Windows and GnuTLS, \I{NSS} or OpenSSL on Unix-alikes. (At the time of
writing Debian-based Linuxen use GnuTLS and RedHat-based ones use
OpenSSL, having previously used NSS.)
OpenSSL, having previously used \I{NSS}.)
}
\examples{
libcurlVersion()
Expand Down
4 changes: 2 additions & 2 deletions src/library/base/man/normalizePath.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ normalizePath(path, winslash = "\\\\", mustWork = NA)
insufficient permissions) it currently falls back to the \R 3.6 (and
older) implementation, which relies on \code{GetFullPathName} and
\code{GetLongPathName} with limitations described in the Notes section.
An attempt is made not to introduce UNC paths in presence of mapped drives
or symbolic links: if \code{GetFinalPathNameByHandle} returns a UNC path,
An attempt is made not to introduce \abbr{UNC} paths in presence of mapped drives
or symbolic links: if \code{GetFinalPathNameByHandle} returns a \abbr{UNC} path,
but \code{GetLongPathName} returns a path starting with a drive letter, R
falls back to the \R 3.6 (and older) implementation.
UTF-8-encoded paths not valid in the current locale can be used.
Expand Down
2 changes: 1 addition & 1 deletion src/library/base/man/parse.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ str2expression(text)
When input is taken from the console, \code{n = NULL} is equivalent to
\code{n = 1}, and \code{n < 0} will read until an \abbr{EOF} character is
read. (The \abbr{EOF} character is Ctrl-Z for the Windows front-ends.) The
read. (The \abbr{EOF} character is \abbr{Ctrl}-Z for the Windows front-ends.) The
line-length limit is 4095 bytes when reading from the console (which
may impose a lower limit: see \sQuote{An Introduction to R}).
Expand Down
2 changes: 1 addition & 1 deletion src/library/base/man/sQuote.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ dQuote(x, q = getOption("useFancyQuotes"))
quotes.
#ifdef windows
This is particularly troublesome in Windows \sQuote{Command Prompt}
windows, which by default are set up to run in the so-called OEM
windows, which by default are set up to run in the so-called \abbr{OEM}
codepage, which in most locales uses a different encoding from
Windows. Further, if the codepage is changed (with \code{chcp.exe},
e.g.\sspace{}to 1252 in a Western European language), the default raster fonts
Expand Down
4 changes: 3 additions & 1 deletion src/library/base/man/save.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 1995-2020 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{save}
\alias{save}
\alias{save.image}
Expand Down Expand Up @@ -76,7 +78,7 @@ save.image(file = ".RData", version = NULL, ascii = FALSE,
promises are saved (together with their evaluation environments).
(Promises embedded in objects are always saved unevaluated.)

All \R platforms use the XDR (bigendian) representation of C ints and
All \R platforms use the \I{XDR} (bigendian) representation of C ints and
doubles in binary save-d files, and these are portable across all \R
platforms.

Expand Down
2 changes: 1 addition & 1 deletion src/library/base/man/seek.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ truncate(con, \dots)
\code{truncate} truncates a file opened for writing at its current
position. It works only for \code{file} connections, and is not
implemented on all platforms: on others (including Windows) it will
not work for large (> 2Gb) files.
not work for large (> 2\abbr{Gb}) files.

None of these should be expected to work on text-mode connections with
re-encoding selected.
Expand Down
4 changes: 3 additions & 1 deletion src/library/base/man/serialize.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
% Copyright 1995-2018 R Core Team
% Distributed under GPL 2 or later

\newcommand{\I}{#1}

\name{serialize}
\alias{serialize}
\alias{unserialize}
Expand All @@ -25,7 +27,7 @@ unserialize(connection, refhook = NULL)
representation is written; otherwise (default) a binary one.
See also the comments in the help for \code{\link{save}}.}
\item{xdr}{a logical: if a binary representation is used, should a
big-endian one (XDR) be used?}
big-endian one (\I{XDR}) be used?}
\item{version}{the workspace format version to use. \code{NULL}
specifies the current default version (3). The only other supported
value is 2, the default from \R 1.4.0 to \R 3.5.0.}
Expand Down
Loading

0 comments on commit 790c46a

Please sign in to comment.