Differential D35883 Diff 109621 share/man/man5/lindebugfs.5

Changeset View

Standalone View

share/man/man5/lindebugfs.5

This file was added.

				.\" $FreeBSD$
				.\" Written by Jake Freeland <jfree@freebsd.org>
				markjUnsubmitted Done Inline Actions We don't include "$FreeBSD$" in new files. Typically you'd add a copyright statement instead of a simple "written by." markj: We don't include "$FreeBSD$" in new files. Typically you'd add a copyright statement instead of…
				.Dd August 10, 2022
				.Dt LINDEBUGFS 5
				.Os
				.Sh NAME
				.Nm lindebugfs
				.Nd Linux file system for debugging
				.Sh SYNOPSIS
				.Bd -literal
				lindebugfs /compat/linux/debugfs debugfs rw 0 0
				.Ed
				.Sh DESCRIPTION
				The debug file system, or debugfs, makes process debugging easier by
				providing a simple API for data transfer between the kernel and user
				space.
				Debugfs was originally released for Linux under a GPL license
				prompting the creation of
				.Nm .
				markjUnsubmitted Done Inline Actions Isn't lindebugfs solely for supporting drivers using the LinuxKPI? If so I'd suggest stating that directly. In other words, this is not a general-purpose filesystem but rather 1) exists mostly for the benefit of developers, and 2) only for LinuxKPI-based drivers. markj: Isn't lindebugfs solely for supporting drivers using the LinuxKPI? If so I'd suggest stating…
				FreeBSD's
				.Nm
				uses the
				.Xr pseudofs 9
				file system construction kit to model itself after Linux's debugfs.
				The
				.Nm
				API is functional, but relatively incomplete at the time of writing.
				.Pp
				When mounted,
				.Nm
				will populate with pseudo files from any running process that calls
				.Nm debugfs_create_file() .
				Since
				.Nm
				is a pseudo file system, file contents will be generated dynamically
				based on program provided file operations.
				The current
				.Nm
				implementation formally supports seq_file and simple_attr_file virtual
				file formats.
				.Sh EXAMPLES
				Load the
				.Nm
				kernel module:
				.Pp
				.Dl "kldload lindebugfs"
				.Pp
				Mount the
				.Nm
				file system on
				.Pa /compat/linux/debugfs :
				.Pp
				.Dl "mount -t debugfs lindebugfs /compat/linux/debugfs"
				markjUnsubmitted Done Inline Actions Oh, this filesystem should really be called "lindebugfs". markj: Oh, this filesystem should really be called "lindebugfs".
				.Sh SEE ALSO
				.Xr linprocfs 5 ,
				.Xr linsysfs 5 ,
				.Xr pseudofs 9 ,
				.Xr linux 4 ,
				.Xr mount 1
				.Sh HISTORY
				The
				.Nm
				file system first appeared in
				.Fx 12.1 .
				.Sh AUTHORS
				.An -nosplit
				The initial implementation for
				.Nm
				was created by Matthew Macy.
				This manual page was written by Jake Freeland.
				markjUnsubmitted Done Inline Actions You need to update share/man/man5/Makefile to ensure that this makefile gets installed. markj: You need to update share/man/man5/Makefile to ensure that this makefile gets installed.