all: fix punctuation regarding "e.g." and "i.e."

Follow the convention of modern English grammar that
a comma should usually come after "e.g." and "i.e.".
This commit is contained in:
CismonX 2025-01-23 19:23:54 +08:00
parent 5d861f4752
commit 3cb99fe85b
No known key found for this signature in database
GPG key ID: 3094873E29A482FB
7 changed files with 21 additions and 21 deletions

View file

@ -164,7 +164,7 @@ Notes
### Targeting 32-bit Platforms ### Targeting 32-bit Platforms
BookmarkFS requires 64-bit `off_t` and `time_t`, which may not be supported BookmarkFS requires 64-bit `off_t` and `time_t`, which may not be supported
on 32-bit platforms (e.g. i386 FreeBSD does not support 64-bit `time_t`). on 32-bit platforms (e.g., i386 FreeBSD does not support 64-bit `time_t`).
If using Autoconf 2.72 or later, the configuration script automatically If using Autoconf 2.72 or later, the configuration script automatically
performs checks and defines necessary macros, and fails if unsupported. performs checks and defines necessary macros, and fails if unsupported.

View file

@ -160,8 +160,8 @@ and cannot help if the operating system has already been compromised.
Examples of what ``untrusted input'' may include: Examples of what ``untrusted input'' may include:
@itemize @bullet{} @itemize @bullet{}
@item Bookmark files that are @emph{not} created by the user using a @item Bookmark files that are @emph{not} created by the user using a trusted
trusted program (e.g. a file obtained from some random person on the internet). program (e.g., a file obtained from some random person on the internet).
@item Filesystem calls from untrusted programs. @item Filesystem calls from untrusted programs.
The program itself may be isolated, but it has a chance to escape The program itself may be isolated, but it has a chance to escape
the isolated environment if it can exploit BookmarkFS. the isolated environment if it can exploit BookmarkFS.
@ -201,7 +201,7 @@ The exact interpretation of this option is backend-defined.
@item target @item target
Pathname of the directory where the filesystem shall be mounted to Pathname of the directory where the filesystem shall be mounted to
(i.e. the ``mountpoint''). (i.e., the ``mountpoint'').
@end table @end table
Files under the filesystem are assigned ownership according to Files under the filesystem are assigned ownership according to
@ -355,7 +355,7 @@ As a bookmark management tool independent from the browser,
BookmarkFS should never update that time automatically. BookmarkFS should never update that time automatically.
Nonetheless, the user is still allowed to explicitly update atime Nonetheless, the user is still allowed to explicitly update atime
(e.g. with @posixfuncmanpage{futimens}). (e.g., with @posixfuncmanpage{futimens}).
@end table @end table
@ -779,7 +779,7 @@ is undefined.
The file associated with the file descriptor no longer exists. The file associated with the file descriptor no longer exists.
The error may occur when the underlying bookmark storage has been modified by The error may occur when the underlying bookmark storage has been modified by
another process (e.g. a web browser) after opening a file. another process (e.g., a web browser) after opening a file.
If the filesystem is mounted in exclusive mode, this error should not occur. If the filesystem is mounted in exclusive mode, this error should not occur.
@end table @end table
@ -844,7 +844,7 @@ This allows filesystem implementations to organize directory entries in a more
relaxed manner. relaxed manner.
There could be extra overhead to maintain a predictable ordering of There could be extra overhead to maintain a predictable ordering of
directory entries, since they may not have a linear structure on modern directory entries, since they may not have a linear structure on modern
on-disk filesystems (e.g. ext4 uses on-disk filesystems (e.g., ext4 uses
@linuxdoc{htree, filesystems/ext4/dynamic.html#hash-tree-directories} @linuxdoc{htree, filesystems/ext4/dynamic.html#hash-tree-directories}
for large directories). for large directories).
@ -915,7 +915,7 @@ Write or search permission is denied for the directory.
@item EINVAL @item EINVAL
@code{name1} or @code{name2} is not a valid filename @code{name1} or @code{name2} is not a valid filename
(e.g. empty string; contains @samp{/} character). (e.g., empty string; contains @samp{/} character).
@item ENOENT @item ENOENT
The directory does not contain entries named @code{name1} or @code{name2}. The directory does not contain entries named @code{name1} or @code{name2}.
@ -1011,7 +1011,7 @@ in the directory stream.
Value of @code{extra} is the ID of the other bookmark. Value of @code{extra} is the ID of the other bookmark.
@item BOOKMARKFS_FSCK_RESULT_NAME_BADCHAR @item BOOKMARKFS_FSCK_RESULT_NAME_BADCHAR
The bookmark contains a bad character (i.e. the ASCII @samp{/} character). The bookmark contains a bad character (i.e., the ASCII @samp{/} character).
Value of @code{extra} is the byte offset where the bad character first appears Value of @code{extra} is the byte offset where the bad character first appears
in @code{name}. in @code{name}.
@ -1115,7 +1115,7 @@ The backend name, equivalent to the value given to the
@item $@{shlib_suffix@} @item $@{shlib_suffix@}
The common filename extension for shared library files on the current platform The common filename extension for shared library files on the current platform
(e.g. @file{.so} on GNU/Linux and FreeBSD). (e.g., @file{.so} on GNU/Linux and FreeBSD).
@end table @end table
@ -1374,7 +1374,7 @@ since Chromium does not have such concepts.
@section Backend API @section Backend API
The Backend API specifies how a BookmarkFS backend communicates with a The Backend API specifies how a BookmarkFS backend communicates with a
frontend program (e.g. @command{mount.bookmarkfs}). frontend program (e.g., @command{mount.bookmarkfs}).
@quotation Warning @quotation Warning
Currently BookmarkFS is experimental. Currently BookmarkFS is experimental.
@ -1663,7 +1663,7 @@ The pointer will be passed to further function calls on this context.
@item bookmarks_root_id @item bookmarks_root_id
ID of the bookmark root directory ID of the bookmark root directory
(i.e. @file{@var{$@{mountpoint@}}/bookmarks}). (i.e., @file{@var{$@{mountpoint@}}/bookmarks}).
Must not be greater than @code{BOOKMARKFS_MAX_ID}. Must not be greater than @code{BOOKMARKFS_MAX_ID}.
If sandboxing is requested, and the ID cannot be determined in a safe way If sandboxing is requested, and the ID cannot be determined in a safe way
@ -1671,7 +1671,7 @@ before entering sandbox, the backend may leave this field as-is or set it
to @code{UINT64_MAX}. to @code{UINT64_MAX}.
@item tags_root_id @item tags_root_id
ID of the tags root directory (i.e. @file{@var{$@{mountpoint@}}/tags}). ID of the tags root directory (i.e., @file{@var{$@{mountpoint@}}/tags}).
Must not be greater than @code{BOOKMARKFS_MAX_ID}. Must not be greater than @code{BOOKMARKFS_MAX_ID}.
This field should be left as-is or set to @code{UINT64_MAX}, This field should be left as-is or set to @code{UINT64_MAX},
@ -1733,7 +1733,7 @@ The handler name, equivalent to the value given to the
@item $@{shlib_suffix@} @item $@{shlib_suffix@}
The common filename extension for shared library files on the current platform The common filename extension for shared library files on the current platform
(e.g. @file{.so} on GNU/Linux and FreeBSD). (e.g., @file{.so} on GNU/Linux and FreeBSD).
@end table @end table
@ -1857,7 +1857,7 @@ Equals to @t{0} if the @option{-o repair} option is given to
Enable unsafe Tcl interpreter features. Enable unsafe Tcl interpreter features.
Should be used in combination with the @option{-o no_sandbox} option Should be used in combination with the @option{-o no_sandbox} option
if you wish to access extra system resources (e.g. open local files). if you wish to access extra system resources (e.g., open local files).
Without this option, the Tcl interpreter has limited functionalities Without this option, the Tcl interpreter has limited functionalities
as if created with @code{interp create -safe}. as if created with @code{interp create -safe}.

View file

@ -13,10 +13,10 @@ The
.B fsck.bookmarkfs .B fsck.bookmarkfs
program checks and optionally repairs a BookmarkFS filesystem. program checks and optionally repairs a BookmarkFS filesystem.
.PP .PP
Unlike fsck for on-disk filesystems (e.g. ext4), this program Unlike fsck for on-disk filesystems (e.g., ext4), this program
does not check for data integrity of the bookmark storage. does not check for data integrity of the bookmark storage.
Instead, it checks for bookmark names that are not valid as filename Instead, it checks for bookmark names that are not valid as filename
(e.g. contains slash characters). (e.g., contains slash characters).
.PP .PP
See the full user manual for details. See the full user manual for details.
.SS Online mode .SS Online mode

View file

@ -1831,7 +1831,7 @@ backend_sandbox (
#ifdef BOOKMARKFS_BACKEND_CHROMIUM_WRITE #ifdef BOOKMARKFS_BACKEND_CHROMIUM_WRITE
if (!(ctx->flags & BOOKMARKFS_BACKEND_READONLY)) { if (!(ctx->flags & BOOKMARKFS_BACKEND_READONLY)) {
// Do not lazy-init iconv in sandbox mode, // Do not lazy-init iconv in sandbox mode,
// since it may want to load modules (e.g. from /usr/lib/gconv). // since it may want to load modules (e.g., from /usr/lib/gconv).
if (0 != init_iconv(&ctx->cd)) { if (0 != init_iconv(&ctx->cd)) {
return -1; return -1;
} }

View file

@ -3142,7 +3142,7 @@ backend_mkfs (
// symbolic link, and SQLite choose to resolve it with readlink(2) // symbolic link, and SQLite choose to resolve it with readlink(2)
// instead of directly open it (see unixFullPathname() in src/os_unix.c), // instead of directly open it (see unixFullPathname() in src/os_unix.c),
// which does not solve the TOCTOU problem. Also, /dev/fd is not portable // which does not solve the TOCTOU problem. Also, /dev/fd is not portable
// (e.g. FreeBSD does not mount fdescfs by default). // (e.g., FreeBSD does not mount fdescfs by default).
// //
// Theoretically we could implement a "VFS shim" to workaround this // Theoretically we could implement a "VFS shim" to workaround this
// problem, but that does not seem to be worthwhile. // problem, but that does not seem to be worthwhile.

View file

@ -90,7 +90,7 @@
#define send_reply(name, ...) \ #define send_reply(name, ...) \
reply_errcheck(fuse_reply_##name(__VA_ARGS__), #name, __LINE__) reply_errcheck(fuse_reply_##name(__VA_ARGS__), #name, __LINE__)
// Some platforms (e.g. Arm Morello) have 128-bit pointers, // Some platforms (e.g., Arm Morello) have 128-bit pointers,
// where we cannot safely store a pointer to `fi->fh`. // where we cannot safely store a pointer to `fi->fh`.
#if defined(SIZEOF_UINTPTR_T) && (SIZEOF_UINTPTR_T > 8) #if defined(SIZEOF_UINTPTR_T) && (SIZEOF_UINTPTR_T > 8)
# error "sizeof(uintptr_t) > sizeof(uint64_t)" # error "sizeof(uintptr_t) > sizeof(uint64_t)"

View file

@ -154,7 +154,7 @@ xrealloc (
/** /**
* Like strerror(), but MT-Safe. * Like strerror(), but MT-Safe.
* *
* NOTE: strerror() is MT-Safe in some implementations (e.g. glibc >= 2.32), * NOTE: strerror() is MT-Safe in some implementations (e.g., glibc >= 2.32),
* but POSIX does not enforce that. * but POSIX does not enforce that.
*/ */
BOOKMARKFS_INTERNAL BOOKMARKFS_INTERNAL