Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

intro.9: minor changes #813

Closed
wants to merge 8 commits into from
Closed

intro.9: minor changes #813

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4e5a36d
intro.9: minor changes
grahamperrin Aug 6, 2023
84ef825
intro.9: reword the line for intr_event(9)
grahamperrin Aug 6, 2023
0c4471a
intro(9): revert some suggested changes
grahamperrin Aug 7, 2023
b87b5a7
intro(9): KASAN(9), KMSAN(9): reorder
grahamperrin Aug 7, 2023
26786f1
intro(9): vnode(9): active voice
grahamperrin Aug 7, 2023
15b9c9b
intro.9: codebase whose documentation
grahamperrin Jan 27, 2024
5ed65c5
intro(9): LOCK_PROFILING(9) kernel config option
grahamperrin Jan 30, 2024
3d88b6d
intro(9): break a long line
grahamperrin Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 18 additions & 17 deletions share/man/man9/intro.9
View file
Open in desktop
Expand Up @@ -6,7 +6,7 @@
.\" This manual page was written by Mitchell Horne <mhorne@FreeBSD.org> under
.\" sponsorship from the FreeBSD Foundation.
.\"
.Dd August 2, 2023
.Dd August 7, 2023
.Dt INTRO 9
.Os
.Sh NAME
Expand All @@ -16,7 +16,7 @@
Welcome to the
.Fx
kernel documentation.
Outside of the source code itself, this set of
Outside the source code itself, this set of
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved
.Xr man 1
pages is the primary resource for information on usage of the numerous
programming interfaces available within the kernel.
Expand All @@ -33,7 +33,7 @@ the first time will be able to understand.
.Pp
To further set expectations, we acknowledge that kernel documentation, like the
source code itself, is forever a work-in-progress.
There will be large sections of the codebase whose documentation is subtly or
There will be large sections of the codebase where documentation is subtly or
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved
severely outdated, or missing altogether.
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved
This documentation is a supplement to the source code, and can not always be
taken at face value.
Expand Down Expand Up @@ -177,9 +177,9 @@ The kernel interface for file systems is
File system implementations register themselves with
.Xr vfsconf 9 .
.Pp
The abstract and filesystem-independent representation of a file, directory, or
other file-like entity within the kernel is the
.Xr vnode 9 .
The
.Xr vnode 9
is the abstract and filesystem-independent representation of a file, directory, or other file-like entity within the kernel.
.Pp
The implementation of access control lists for filesystems is described by
.Xr acl 9 .
Expand Down Expand Up @@ -371,7 +371,7 @@ Signals can be sent to processes or process groups using the functions
described by
.Xr psignal 9 .
.Ss Security
See the generic security overview in
See the overview in
.Xr security 7 .
.Pp
The basic structure for user credentials is
Expand All @@ -397,7 +397,7 @@ see
.Xr mac 9 .
.Pp
Cryptographic services are provided by the OpenCrypto framework.
This API provides and interface for both consumers and crypto drivers;
This API provides an interface for both consumers and crypto drivers;
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved
see
.Xr crypto 9 .
.Pp
Expand All @@ -409,9 +409,9 @@ and
The interfaces for declaring loadable kernel modules are described by
.Xr module 9 .
.Ss Interrupts
The machine-independent portion of the interrupt framework supporting the
registration and execution of interrupt handlers is described by
.Xr intr_event 9 .
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved
.Xr intr_event 9
describes the machine-independent portion of the interrupt framework
that supports registration and execution of interrupt handlers.
.Pp
Software interrupts are provided by
.Xr swi 9 .
Expand Down Expand Up @@ -450,10 +450,11 @@ Kernel sanitizers can perform additional compiler-assisted checks against
memory use/access.
These runtimes are capable of detecting difficult-to-identify classes of bugs,
at the cost of a large overhead.
Supported is the Kernel Address Sanitizer
.Xr KASAN 9 ,
and the Kernel Memory Sanitizer
.Xr KMSAN 9 .
The Kernel Address Sanitizer
.Xr KASAN 9
and Kernel Memory Sanitizer
.Xr KMSAN 9
are supported.
.Pp
The
.Cd LOCK_PROFILING
grahamperrin marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -514,6 +515,6 @@ The kernel object implementation is described by
.Xr man 1 ,
.Xr style 9
.Rs
.%T "The FreeBSD Architecture Handbook"
.%U "https://docs.freebsd.org/en/books/arch-handbook/"
.%T The FreeBSD Architecture Handbook
.%U https://docs.freebsd.org/en/books/arch-handbook/
.Re