On 6/18/19 2:56 PM, Darrick J. Wong wrote: > On Mon, Jun 17, 2019 at 12:27:26PM -0500, Eric Sandeen wrote: >> On 6/7/19 2:29 PM, Darrick J. Wong wrote: >>> From: Darrick J. Wong <darrick.wong@xxxxxxxxxx> >>> >>> Create a separate manual page for the fs shutdown ioctl so we can >>> document how it works. >>> >>> Signed-off-by: Darrick J. Wong <darrick.wong@xxxxxxxxxx> >>> --- >>> man/man2/ioctl_xfs_goingdown.2 | 61 ++++++++++++++++++++++++++++++++++++++++ >>> man/man3/xfsctl.3 | 7 +++++ >>> 2 files changed, 68 insertions(+) >>> create mode 100644 man/man2/ioctl_xfs_goingdown.2 >>> >>> >>> diff --git a/man/man2/ioctl_xfs_goingdown.2 b/man/man2/ioctl_xfs_goingdown.2 >>> new file mode 100644 >>> index 00000000..e9a56f28 >>> --- /dev/null >>> +++ b/man/man2/ioctl_xfs_goingdown.2 >>> @@ -0,0 +1,61 @@ >>> +.\" Copyright (c) 2019, Oracle. All rights reserved. >>> +.\" >>> +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) >>> +.\" SPDX-License-Identifier: GPL-2.0+ >>> +.\" %%%LICENSE_END >>> +.TH IOCTL-XFS-GOINGDOWN 2 2019-04-16 "XFS" >>> +.SH NAME >>> +ioctl_xfs_goingdown \- shut down an XFS filesystem >>> +.SH SYNOPSIS >>> +.br >>> +.B #include <xfs/xfs_fs.h> >>> +.PP >>> +.BI "int ioctl(int " fd ", XFS_IOC_GOINGDOWN, uint32_t " flags ); >>> +.SH DESCRIPTION >>> +Shuts down a live XFS filesystem. >>> +This is a software initiated hard shutdown and should be avoided whenever >>> +possible. >>> +After this call completes, the filesystem will be totally unusable and must be >>> +unmounted. >>> + >>> +.PP >>> +.I flags >>> +can be one of the following: >>> +.RS 0.4i >>> +.TP >>> +.B XFS_FSOP_GOING_FLAGS_DEFAULT >>> +Flush all dirty data and in-core state to disk, flush the log, then shut down. >>> +.TP >>> +.B XFS_FSOP_GOING_FLAGS_LOGFLUSH >>> +Flush all pending transactions to the log, then shut down, leaving all dirty >>> +data unwritten. >>> +.TP >>> +.B XFS_FSOP_GOING_FLAGS_NOLOGFLUSH >>> +Shut down, leaving all dirty transactions and dirty data. >> >> leaving it ... what? >> >> Maybe "Shut down, without flushing any dirty transactions or data to disk." > > "Shut down immediately, without writing pending transactions or dirty data > to disk." ? The two other cases use "flush" terminology so I was sticking with that. If "write" is less jargon-y then I'd do it for all of them - using similar terminology for all 3 cases helps the reader understand the differences more clearly, I think. -Eric
