Bug#694624: freezes under lying (root) - patch
A patch for the man page is (hopefully) attached. I'll warn you that this is the first time I've edited a man page or generated a patch, so it could be wrong / incomplete.
By the way, I think you may have misinterpreted my tone in previous comments, I was trying to make a strong case for the program working in the way I expected it to from reading the man page, not trying to tell you how it should work in general. Having said that I still personally consider a 'safety catch' on the root filesystem would be a good idea. Thanks,
Pat
Description: Updates to the man page to more accurately describe the
behaviour of the program.
Forwarded: not-needed
Bug-Debian: http://bugs.debian.org/694624
Author: Patrick Emblen <[email protected]>
man/man8/xfs_freeze.8 +26 -19
@@ -1,16 +1,17 @@ .TH xfs_freeze 8 .SH NAME -xfs_freeze \- suspend access to an XFS filesystem +xfs_freeze \- suspend access to a freezable filesystem .SH SYNOPSIS .B xfs_freeze \-f | .B \-u -.I mount-point -.fi -.SH DESCRIPTION -.B xfs_freeze -suspends and resumes access to an XFS filesystem (see -.BR xfs (5)). +.I path.fi +.SH DESCRIPTION.B xfs_freezesuspends and resumes access to compatible filesystems. +The command was originaly specific to the XFS filesystem (see +.BR xfs (5))but since Linux kernel version 2.6.29, the interface which +XFS uses to freeze and unfreeze has been elevated to the VFS, so that +this tool can now be used on many other Linux filesystems. +The root filesystem is not treated in any special way and may also be frozen. .PP .B xfs_freeze halts new access to the filesystem and creates a stable image on disk.
@@ -19,15 +20,14 @@ that support the creation of snapshots. .PP The -.I mount-point -argument is the pathname of the directory where the filesystem -is mounted. -The filesystem must be mounted to be frozen (see -.BR mount (8)). +.I path +argument is the path to any directory within the mounted filesystem up to and including +the +.I mount-point. .PP The .B \-f -flag requests the specified XFS filesystem to be +flag requests the specified filesystem to be frozen from new modifications. When this is selected, all ongoing transactions in the filesystem are allowed to complete, new write system calls are halted, other
@@ -55,16 +55,23 @@ must be supplied to .BR xfs_freeze . .SH NOTES -A copy of a frozen XFS filesystem will usually have the same universally +.BR xfs_freeze +treats the root filesystem the same as any other filesystem. +Take great care to verify that the path you specify contains the filesystem +you intend to freeze and is not for example, an empty mount-point. +If you inadvertently freeze the root filesystem you should immediately +unfreeze it with the +.B \-u +option. If you attempt any action that tries to write to the frozen filesystem +your shell can be blocked waiting for the write and in most cases you will +not be able to open another shell to run the unfreeze command. +.PP +A copy of a frozen filesystem will usually have the same universally unique identifier (UUID) as the original, and thus may be prevented from being mounted. -The XFS +For XFS filesystems, the .B nouuid mount option can be used to circumvent this issue. -.PP -In Linux kernel version 2.6.29, the interface which XFS uses to freeze -and unfreeze was elevated to the VFS, so that this tool can now be -used on many other Linux filesystems. .SH SEE ALSO .BR xfs (5), .BR lvm (8),
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Hey Pat,
Quoted 1 line · Pat Emblen
A patch for the man page is (hopefully) attached.
Thanks for the patch!
Quoted 3 lines
I'll warn you that
this is the first time I've edited a man page or generated a patch, so it could be wrong / incomplete.
Ok, I'll go easy on you then. ;)
There are some guidelines for submitting patches in the kernel sources under Documentation/SubmittingPatches. Please give that a quick read:
I think it will help you. (read: it will help us get your patch in faster)
Quoted 2 lines
Having said that I still personally consider a 'safety catch' on the root filesystem would be a good idea.
I tend to agree. It really sucks that someone had to drive out to the site to get things working again. Not a great situation.
Quoted 14 lines
Description: Updates to the man page to more accurately describe the
behaviour of the program.
Forwarded: not-needed
Bug-Debian: http://bugs.debian.org/694624
Author: Patrick Emblen <[email protected]>man/man8/xfs_freeze.8 +1
-1@@ -1,16 +1,17 @@ .TH xfs_freeze 8 .SH NAME -xfs_freeze \- suspend access to an XFS filesystem +xfs_freeze \- suspend access to a freezable filesystem .SH SYNOPSIS .B xfs_freeze \-f
man/man8/xfs_freeze.8 line 9
Quoted 10 lines
man/man8/xfs_freeze.8 +2
-6| .B \-u -.I mount-point -.fi -.SH DESCRIPTION -.B xfs_freeze -suspends and resumes access to an XFS filesystem (see -.BR xfs (5)). +.I path.fi +.SH DESCRIPTION.B xfs_freezesuspends and resumes access to compatible filesystems.
^^ Do you need a newline there?
xfs_freeze suspends
man/man8/xfs_freeze.8 line 11
Quoted 2 lines
man/man8/xfs_freeze.8 +2
-0+The command was originaly specific to the XFS filesystem (see +.BR xfs (5))but since Linux kernel version 2.6.29, the interface which
^^^^^^^ This displays without spaces between. e.g butsinceLinuxKernelVersion2.
man/man8/xfs_freeze.8 line 14
Quoted 3 lines
man/man8/xfs_freeze.8 +3
-0+XFS uses to freeze and unfreeze has been elevated to the VFS, so that +this tool can now be used on many other Linux filesystems. +The root filesystem is not treated in any special way and may also be frozen.
I think this history lesson was more appropriate in the notes section of the manpage.
Quoted 6 lines
man/man8/xfs_freeze.8 +0
-0.PP .B xfs_freeze halts new access to the filesystem and creates a stable image on disk.@@ -19,15 +20,14 @@ that support the creation of snapshots. .PP
man/man8/xfs_freeze.8 line 26
Quoted 10 lines
man/man8/xfs_freeze.8 +4
-5The -.I mount-point -argument is the pathname of the directory where the filesystem -is mounted. -The filesystem must be mounted to be frozen (see -.BR mount (8)). +.I path +argument is the path to any directory within the mounted filesystem up to and including +the +.I mount-point.
Not sure you need 'up to and including the mount-point'?
man/man8/xfs_freeze.8 line 30
Quoted 5 lines
man/man8/xfs_freeze.8 +1
-1.PP The .B \-f -flag requests the specified XFS filesystem to be +flag requests the specified filesystem to be
Ok.
man/man8/xfs_freeze.8 line 62
Quoted 13 lines
man/man8/xfs_freeze.8 +4
-1frozen from new modifications. When this is selected, all ongoing transactions in the filesystem are allowed to complete, new write system calls are halted, other@@ -55,16 +55,23 @@ must be supplied to .BR xfs_freeze . .SH NOTES -A copy of a frozen XFS filesystem will usually have the same universally +.BR xfs_freeze +treats the root filesystem the same as any other filesystem. +Take great care to verify that the path you specify contains the filesystem +you intend to freeze and is not for example, an empty mount-point.
I think this is all you need, just make it bold?
man/man8/xfs_freeze.8 line 69
Quoted 8 lines
man/man8/xfs_freeze.8 +8
-0+If you inadvertently freeze the root filesystem you should immediately +unfreeze it with the +.B \-u +option. If you attempt any action that tries to write to the frozen filesystem +your shell can be blocked waiting for the write and in most cases you will +not be able to open another shell to run the unfreeze command. +.PP +A copy of a frozen filesystem will usually have the same universally
That's pretty wordy... do we really need all that?
Quoted 12 lines
man/man8/xfs_freeze.8 +1
-5unique identifier (UUID) as the original, and thus may be prevented from being mounted. -The XFS +For XFS filesystems, the .B nouuid mount option can be used to circumvent this issue. -.PP -In Linux kernel version 2.6.29, the interface which XFS uses to freeze -and unfreeze was elevated to the VFS, so that this tool can now be -used on many other Linux filesystems. .SH SEE ALSO .BR xfs (5),
Quoted 1 line
.BR lvm (8),
Could you clean those up and repost? If not we'll figure something out eventually. ;)
Thanks again,
Ben
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs