From a2344cf159d3a802480a589c63d63aa16a498ce1 Mon Sep 17 00:00:00 2001 From: Andrea Mazzoleni Date: Wed, 16 Nov 2011 20:42:27 +0100 Subject: [PATCH] Some final changes. --- HISTORY | 14 +++++++------- snapraid.1 | 28 ++++++++++++++-------------- snapraid.d | 28 ++++++++++++++-------------- snapraid.txt | 28 ++++++++++++++-------------- 4 files changed, 49 insertions(+), 49 deletions(-) diff --git a/HISTORY b/HISTORY index 09abd8d2..a69ad33d 100644 --- a/HISTORY +++ b/HISTORY @@ -13,24 +13,24 @@ SnapRAID HISTORY content files in data disks. * Added checks to ensure that data and parity disks are diffent, and to correctly count the number of copies of "content" files in different disks. -* Removed the dependency of the 'disk' order specification in the configuration +* Removed the dependency of the "disk" order specification in the configuration file. The used order is now saved in the content file to avoid to damage the dual parity in case the order is changed by the user. It easily allows to remove or add disks from the array when using a dual parity. -* Improved the 'fix' performance when a lot of files or the parity have to be +* Improved the "fix" performance when a lot of files or the parity have to be recreated from scratch. * When getting unrecoverable errors, the printed log line now starts with - 'unrecoverable:' instead of 'error:' to allow an easier identification. -* Added a new option '--find-by-name' to allow to sync using only the + "unrecoverable:" instead of "error:" to allow an easier identification. +* Added a new option "--find-by-name" to allow to sync using only the file path and not the inode. This is useful to avoid long sync when you replace one disk with another copying manually the files. -* If 'fix' cannot recover a file, it's renamed adding the '.unrecoverable' +* If "fix" cannot recover a file, it's renamed adding the ".unrecoverable" extension. * Checking and fixing also empty files with size 0. -1.6 2011/9 - THIS UPDATE IS HIGHLY RECOMMENDED! -=============================================== +1.6 2011/9 +========== * The content file is now saved also at the start of the "sync" command. This avoids parity errors if the sync process aborted without saving the content file and you made changes at the disk array before diff --git a/snapraid.1 b/snapraid.1 index a72eed16..68ffa59b 100644 --- a/snapraid.1 +++ b/snapraid.1 @@ -319,7 +319,7 @@ After a successful \(a"fix\(a", you should also run a \(a"sync\(a" command to update the new state of the files. .PP All the files that cannot be fixed are renamed adding -the \(cq.unrecoverable\(cq extension. +the \(a".unrecoverable\(a" extension. .PP The \(a"content\(a" file is NOT modified. The \(a"parity\(a" and \(a"q\(hyparity\(a" files are modified if necessary. @@ -329,7 +329,7 @@ SnapRAID provides the following options: .TP .B \(hyc, \(hy\(hyconf CONFIG Selects the configuration file. If not specified it\(cqs assumed -the file \(cq/etc/snapraid.conf\(cq in Unix, and \(cqsnapraid.conf\(cq in +the file \(a"/etc/snapraid.conf\(a" in Unix, and \(a"snapraid.conf\(a" in the current directory in Windows. .TP .B \(hyf, \(hy\(hyfilter PATTERN @@ -343,13 +343,13 @@ In Unix, ensure to quote globbing chars if used. .B \(hyN, \(hy\(hyfind\(hyby\(hyname When syncing finds the files by name instead than by inode. This option allows a fast sync command after having replaced -one physical disk with another copying manually the files. -Without this option the \(cqsync\(cq command recognizes that +one physical disk with another, copying manually the files. +Without this option the \(a"sync\(a" command recognizes that the files were copied to a different disk, and it will resync them all. Instead, with this option, a file with the correct name, size and time is assumed identical at the previous one. -This option has effect only on the \(cqsync\(cq and \(cqdiff\(cq commands. +This option has effect only on the \(a"sync\(a" and \(a"diff\(a" commands. .TP .B \(hyZ, \(hy\(hyforce\(hyzero Forces the insecure operation of syncing a file with zero @@ -723,7 +723,7 @@ The worst happened, and you lost a disk! DO NOT PANIC! You will be able to recover it! .PP The first thing you have to do is to avoid futher changes at you disk array. -Disable any remote connections to it, any scheduled processes, including any +Disable any remote connection to it, any scheduled process, including any scheduled SnapRAID nightly sync. .PP Then proceed with the following steps. @@ -731,7 +731,7 @@ Then proceed with the following steps. You need some space to recover, even better if you already have an additional disk, but in case, also an external USB or remote one is enough. .PP -Change the SnapRAID configuration and change the \(cqdisk\(cq directory +Change the SnapRAID configuration and change the \(a"disk\(a" directory of the failed disk to point to the new empty space. .SS STEP 2 \(hy> Fix Run the fix command, storing the log in an external file with: @@ -755,14 +755,14 @@ You can get a detailed list of all the unrecoverable blocks in the fix.log file checking all the lines starting with \(a"unrecoverable:\(a" .PP If you are not satified of the recovering, you can retry it as many time you wish. -For example, if you have moved away some files from other disks after the last \(cqsync\(cq, -you can retry to put them inplace, and retry the \(cqfix\(cq. +For example, if you have moved away some files from other disks after the last \(a"sync\(a", +you can retry to put them inplace, and retry the \(a"fix\(a". .PP If you are satisfied of the recovering, you can now proceed further, but take care that after synching you will no more able to retry the -\(cqfix\(cq command! +\(a"fix\(a" command! .SS STEP 3 \(hy> Check -As paranoid check, you can now run a whole \(cqcheck\(cq command to ensure that +As paranoid check, you can now run a whole \(a"check\(a" command to ensure that everything is OK. .PP .RS 4 @@ -774,11 +774,11 @@ snapraid check .PP This command will take a long time. .SS STEP 4 \(hy> Sync -Run the \(cqsync\(cq command to resyncronize the array with the new disk. +Run the \(a"sync\(a" command to resyncronize the array with the new disk. .PP -To avoid a long time sync you can use the \(cq\(hy\(hyfind\(hyby\(hyname\(cq option to +To avoid a long time sync you can use the \(a"\(hy\(hyfind\(hyby\(hyname\(a" option to force SnapRAID to ignore the fact that all the recovered files are now in -a different physical disk, and they don\(cqt need to be synched. +a different physical disk, but they are not changed. .PP .RS 4 snapraid \(hy\(hyfind\(hyby\(hyname sync diff --git a/snapraid.d b/snapraid.d index d532fa34..4135c2a0 100644 --- a/snapraid.d +++ b/snapraid.d @@ -208,7 +208,7 @@ Commands command to update the new state of the files. All the files that cannot be fixed are renamed adding - the '.unrecoverable' extension. + the ".unrecoverable" extension. The "content" file is NOT modified. The "parity" and "q-parity" files are modified if necessary. @@ -219,7 +219,7 @@ Options -c, --conf CONFIG Selects the configuration file. If not specified it's assumed - the file '/etc/snapraid.conf' in Unix, and 'snapraid.conf' in + the file "/etc/snapraid.conf" in Unix, and "snapraid.conf" in the current directory in Windows. -f, --filter PATTERN @@ -233,13 +233,13 @@ Options -N, --find-by-name When syncing finds the files by name instead than by inode. This option allows a fast sync command after having replaced - one physical disk with another copying manually the files. - Without this option the 'sync' command recognizes that + one physical disk with another, copying manually the files. + Without this option the "sync" command recognizes that the files were copied to a different disk, and it will resync them all. Instead, with this option, a file with the correct name, size and time is assumed identical at the previous one. - This option has effect only on the 'sync' and 'diff' commands. + This option has effect only on the "sync" and "diff" commands. -Z, --force-zero Forces the insecure operation of syncing a file with zero @@ -488,7 +488,7 @@ Recovering DO NOT PANIC! You will be able to recover it! The first thing you have to do is to avoid futher changes at you disk array. - Disable any remote connections to it, any scheduled processes, including any + Disable any remote connection to it, any scheduled process, including any scheduled SnapRAID nightly sync. Then proceed with the following steps. @@ -497,7 +497,7 @@ Recovering You need some space to recover, even better if you already have an additional disk, but in case, also an external USB or remote one is enough. - Change the SnapRAID configuration and change the 'disk' directory + Change the SnapRAID configuration and change the "disk" directory of the failed disk to point to the new empty space. STEP 2 -> Fix @@ -517,15 +517,15 @@ Recovering checking all the lines starting with "unrecoverable:" If you are not satified of the recovering, you can retry it as many time you wish. - For example, if you have moved away some files from other disks after the last 'sync', - you can retry to put them inplace, and retry the 'fix'. + For example, if you have moved away some files from other disks after the last "sync", + you can retry to put them inplace, and retry the "fix". If you are satisfied of the recovering, you can now proceed further, but take care that after synching you will no more able to retry the - 'fix' command! + "fix" command! STEP 3 -> Check - As paranoid check, you can now run a whole 'check' command to ensure that + As paranoid check, you can now run a whole "check" command to ensure that everything is OK. :snapraid check @@ -533,11 +533,11 @@ Recovering This command will take a long time. STEP 4 -> Sync - Run the 'sync' command to resyncronize the array with the new disk. + Run the "sync" command to resyncronize the array with the new disk. - To avoid a long time sync you can use the '--find-by-name' option to + To avoid a long time sync you can use the "--find-by-name" option to force SnapRAID to ignore the fact that all the recovered files are now in - a different physical disk, and they don't need to be synched. + a different physical disk, but they are not changed. :snapraid --find-by-name sync diff --git a/snapraid.txt b/snapraid.txt index d35b5d7d..37311274 100644 --- a/snapraid.txt +++ b/snapraid.txt @@ -232,7 +232,7 @@ After a successful "fix", you should also run a "sync" command to update the new state of the files. All the files that cannot be fixed are renamed adding -the '.unrecoverable' extension. +the ".unrecoverable" extension. The "content" file is NOT modified. The "parity" and "q-parity" files are modified if necessary. @@ -246,7 +246,7 @@ SnapRAID provides the following options: -c, --conf CONFIG Selects the configuration file. If not specified it's assumed - the file '/etc/snapraid.conf' in Unix, and 'snapraid.conf' in + the file "/etc/snapraid.conf" in Unix, and "snapraid.conf" in the current directory in Windows. -f, --filter PATTERN @@ -260,13 +260,13 @@ SnapRAID provides the following options: -N, --find-by-name When syncing finds the files by name instead than by inode. This option allows a fast sync command after having replaced - one physical disk with another copying manually the files. - Without this option the 'sync' command recognizes that + one physical disk with another, copying manually the files. + Without this option the "sync" command recognizes that the files were copied to a different disk, and it will resync them all. Instead, with this option, a file with the correct name, size and time is assumed identical at the previous one. - This option has effect only on the 'sync' and 'diff' commands. + This option has effect only on the "sync" and "diff" commands. -Z, --force-zero Forces the insecure operation of syncing a file with zero @@ -538,7 +538,7 @@ The worst happened, and you lost a disk! DO NOT PANIC! You will be able to recover it! The first thing you have to do is to avoid futher changes at you disk array. -Disable any remote connections to it, any scheduled processes, including any +Disable any remote connection to it, any scheduled process, including any scheduled SnapRAID nightly sync. Then proceed with the following steps. @@ -547,7 +547,7 @@ Then proceed with the following steps. You need some space to recover, even better if you already have an additional disk, but in case, also an external USB or remote one is enough. -Change the SnapRAID configuration and change the 'disk' directory +Change the SnapRAID configuration and change the "disk" directory of the failed disk to point to the new empty space. ---- 9.0.2 STEP 2 -> Fix ---- @@ -567,15 +567,15 @@ You can get a detailed list of all the unrecoverable blocks in the fix.log file checking all the lines starting with "unrecoverable:" If you are not satified of the recovering, you can retry it as many time you wish. -For example, if you have moved away some files from other disks after the last 'sync', -you can retry to put them inplace, and retry the 'fix'. +For example, if you have moved away some files from other disks after the last "sync", +you can retry to put them inplace, and retry the "fix". If you are satisfied of the recovering, you can now proceed further, but take care that after synching you will no more able to retry the -'fix' command! +"fix" command! ---- 9.0.3 STEP 3 -> Check ---- -As paranoid check, you can now run a whole 'check' command to ensure that +As paranoid check, you can now run a whole "check" command to ensure that everything is OK. snapraid check @@ -583,11 +583,11 @@ everything is OK. This command will take a long time. ---- 9.0.4 STEP 4 -> Sync ---- -Run the 'sync' command to resyncronize the array with the new disk. +Run the "sync" command to resyncronize the array with the new disk. -To avoid a long time sync you can use the '--find-by-name' option to +To avoid a long time sync you can use the "--find-by-name" option to force SnapRAID to ignore the fact that all the recovered files are now in -a different physical disk, and they don't need to be synched. +a different physical disk, but they are not changed. snapraid --find-by-name sync