Skip to content

Commit 60453da

Browse files
committed
[fs.definitions] Replace "Terms and definitions" formatting with inline definitions.
These definitions do not satisfy ISO rules for a "Terms and definitions" section, and in any case it does not make sense for FS to have its own "Terms and definitions". Following our usual convention, we use inline definitions for locally-scoped terms.
1 parent 5619b65 commit 60453da

File tree

1 file changed

+61
-45
lines changed

1 file changed

+61
-45
lines changed

source/iostreams.tex

Lines changed: 61 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -10006,36 +10006,41 @@
1000610006
products.
1000710007
}
1000810008

10009-
\rSec2[fs.definitions]{Terms and definitions}
10009+
\rSec2[fs.definitions]{Terminology}
1001010010

10011-
\definition{absolute path}{fs.def.absolute.path}
10012-
A path that unambiguously
10011+
\pnum
10012+
An \defn{absolute path} is a path that unambiguously
1001310013
identifies the location of a file without reference to an additional starting
1001410014
location. The elements of a path that determine if it is absolute are
1001510015
operating system dependent.
1001610016

10017-
\definition{directory}{fs.def.directory}
10018-
A file within a file system that acts as a container of directory entries
10017+
\pnum
10018+
A \defn{directory} is
10019+
a file within a file system that acts as a container of directory entries
1001910020
that contain information about
1002010021
other files, possibly including other directory files.
1002110022

10022-
\definition{file}{fs.def.file}
10023-
An object within a file system that holds user or system data. Files can be written to, or read from, or both. A file
10023+
\pnum
10024+
A \defn{file} is
10025+
an object within a file system that holds user or system data. Files can be written to, or read from, or both. A file
1002410026
has certain attributes, including type. File types include regular files
1002510027
and directories. Other types of files, such as symbolic links\iref{fs.def.symlink},
1002610028
may be supported by the implementation.
1002710029

10028-
\definition{file system}{fs.def.filesystem}
10029-
A collection of files and their attributes.
10030+
\pnum
10031+
A \defn{file system} is
10032+
a collection of files and their attributes.
1003010033

10031-
\definition{file system race}{fs.def.race}
10032-
The condition that occurs
10034+
\pnum
10035+
A \defn{file system race} is
10036+
the condition that occurs
1003310037
when multiple threads, processes, or computers interleave access and
1003410038
modification of
1003510039
the same object within a file system.
1003610040

10037-
\definition{filename}{fs.def.filename}
10038-
The name of a file. Filenames \grammarterm{dot} and \grammarterm{dot-dot},
10041+
\pnum
10042+
A \defn{filename} is
10043+
the name of a file. Filenames \grammarterm{dot} and \grammarterm{dot-dot},
1003910044
consisting solely of one and two period characters respectively,
1004010045
have special meaning.
1004110046
The following characteristics of filenames are operating system dependent:
@@ -10050,30 +10055,32 @@
1005010055
files, such as directories.
1005110056
\end{itemize}
1005210057

10053-
\definition{hard link}{fs.def.hardlink}
10054-
A link\iref{fs.def.link} to an existing file. Some
10058+
\pnum
10059+
A \defn{hard link} is
10060+
a link\iref{fs.def.link} to an existing file. Some
1005510061
file systems support multiple hard links to a file. If the last hard link to a
1005610062
file is removed, the file itself is removed.
1005710063
\begin{note} A hard link can be thought of as a shared-ownership smart
1005810064
pointer to a file.\end{note}
1005910065

10060-
\definition{link}{fs.def.link}
10061-
An object that associates a filename with a file. Several links can associate names with the same file.
10066+
\pnum
10067+
A \defn{link} is
10068+
an object that associates a filename with a file. Several links can associate names with the same file.
1006210069

10063-
\definition{native encoding}{fs.def.native.encode}
10064-
For narrow character strings, the operating system dependent current encoding
10065-
for pathnames\iref{fs.def.pathname}. For wide character strings, the implementation-defined execution
10070+
\pnum
10071+
The \defn{native encoding} of a narrow character string is
10072+
the operating system dependent current encoding
10073+
for pathnames\iref{fs.def.pathname}.
10074+
The \defn{native encoding} for wide character strings is
10075+
the implementation-defined execution
1006610076
wide-character set encoding\iref{lex.charset}.
1006710077

10068-
\definition{native pathname format}{fs.def.native}
10069-
The operating system dependent pathname format accepted by the host operating system.
10070-
10071-
\definition{normal form}{fs.def.normal.form}
10072-
A path in normal form is said to be \term{normalized}.
10073-
The process of obtaining a normalized path
10074-
from a path that is not in normal form is called \term{normalization}.
10078+
\pnum
10079+
The \defn{native pathname format} is
10080+
the operating system dependent pathname format accepted by the host operating system.
1007510081

10076-
Normalization of a generic format pathname means:
10082+
\pnum
10083+
\defnx{Normalization}{normalization!path} of a generic format pathname means:
1007710084

1007810085
\begin{enumerate}
1007910086
\item If the path is empty, stop.
@@ -10092,52 +10099,61 @@
1009210099
\item If the path is empty, add a \grammarterm{dot}.
1009310100
\end{enumerate}
1009410101

10095-
\definition{operating system dependent behavior}{fs.def.osdep}
10096-
Behavior that is dependent upon the behavior
10102+
The result of normalization is a path in \defn{normal form},
10103+
which is said to be \term{normalized}.
10104+
10105+
\pnum
10106+
\defnx{Operating system dependent behavior}{operating system dependent behavior} is
10107+
behavior that is dependent upon the behavior
1009710108
and characteristics of an operating system. See~\ref{fs.conform.os}.
1009810109

10099-
\definition{parent directory}{fs.def.parent}
10100-
\defncontext{of a directory} the directory that both contains a
10110+
\pnum
10111+
The \defn{parent directory} of a directory is
10112+
the directory that both contains a
1010110113
directory entry for the given directory and is represented by the filename
1010210114
\grammarterm{dot-dot} in the given directory.
10103-
10104-
\definition{parent directory}{fs.def.parent.other}
10105-
\defncontext{of other types of files} a directory containing a directory
10115+
The \defn{parent directory}
10116+
of other types of files is a directory containing a directory
1010610117
entry for the file under discussion.
1010710118

10108-
\definition{path}{fs.def.path}
10109-
A sequence of elements that identify
10119+
\pnum
10120+
A \defn{path} is
10121+
a sequence of elements that identify
1011010122
the location of a file within a filesystem.
1011110123
The elements are the
1011210124
\grammarterm{root-name}\opt{},
1011310125
\grammarterm{root-directory}\opt{},
1011410126
and an optional sequence of filenames.
1011510127
The maximum number of elements in the sequence is operating system dependent.
1011610128

10117-
\definition{pathname}{fs.def.pathname}
10118-
A character string that represents the name of a path. Pathnames are
10129+
\pnum
10130+
A \defn{pathname} is
10131+
a character string that represents the name of a path. Pathnames are
1011910132
formatted according to the generic pathname format grammar\iref{fs.path.generic} or an
1012010133
operating system dependent
1012110134
native pathname format.
1012210135

10123-
\definition{pathname resolution}{fs.def.pathres}
10124-
Pathname resolution is the operating system dependent mechanism for resolving
10136+
\pnum
10137+
\defnx{Pathname resolution}{pathname resolution}
10138+
is the operating system dependent mechanism for resolving
1012510139
a pathname to a particular file in a file hierarchy. There may be multiple
1012610140
pathnames that resolve to the same file.
1012710141
\begin{example} POSIX specifies the mechanism in section 4.11, Pathname resolution.
1012810142
\end{example}
1012910143

10130-
\definition{relative path}{fs.def.rel.path}
10131-
A path that is not absolute, and as such, only unambiguously
10144+
\pnum
10145+
A \defn{relative path} is
10146+
a path that is not absolute, and as such, only unambiguously
1013210147
identifies the location of a file when resolved\iref{fs.def.pathres} relative to
1013310148
an implied starting location. The elements of a path that determine if it is
1013410149
relative are operating system dependent.
1013510150
\begin{note}
1013610151
Pathnames ``.'' and ``..'' are relative paths.
1013710152
\end{note}
1013810153

10139-
\definition{symbolic link}{fs.def.symlink}
10140-
A type of file with the
10154+
\pnum
10155+
A \defn{symbolic link} is
10156+
a type of file with the
1014110157
property that when the file is encountered during pathname resolution, a string
1014210158
stored by the file is used to modify the pathname resolution.
1014310159
\begin{note} Symbolic links are often called symlinks. A symbolic link can be thought of as a raw pointer to a file.

0 commit comments

Comments
 (0)