From 3ff8ef499c56008f4d2ebf5b81e08e98eb0c0826 Mon Sep 17 00:00:00 2001 From: Andrew Deason Date: Thu, 28 Jun 2012 15:30:40 -0500 Subject: [PATCH] doc: Consolidate CAUTIONS notes about volume size Change-Id: I264906fb3f61db62c483982f613654a9a897f417 Reviewed-on: http://gerrit.openafs.org/7597 Reviewed-by: Jeffrey Altman Tested-by: Jeffrey Altman --- doc/man-pages/NTMakefile | 11 +++++++++++ doc/man-pages/pod1/.gitignore | 11 +++++++++++ doc/man-pages/pod1/fragments/volsize-caution.pod | 1 + .../pod1/{fs_listquota.pod => fs_listquota.pod.in} | 2 +- doc/man-pages/pod1/{fs_quota.pod => fs_quota.pod.in} | 2 +- .../pod1/{fs_setquota.pod => fs_setquota.pod.in} | 2 +- .../pod1/{fs_setvol.pod => fs_setvol.pod.in} | 2 +- doc/man-pages/pod1/{vos.pod => vos.pod.in} | 2 +- .../pod1/{vos_clone.pod => vos_clone.pod.in} | 2 +- doc/man-pages/pod1/vos_copy.pod.in | 2 +- .../pod1/{vos_create.pod => vos_create.pod.in} | 2 +- .../pod1/{vos_examine.pod => vos_examine.pod.in} | 2 +- doc/man-pages/pod1/{vos_move.pod => vos_move.pod.in} | 2 +- .../pod1/{vos_partinfo.pod => vos_partinfo.pod.in} | 2 +- .../pod1/{vos_shadow.pod => vos_shadow.pod.in} | 2 +- 15 files changed, 35 insertions(+), 12 deletions(-) create mode 100644 doc/man-pages/pod1/fragments/volsize-caution.pod rename doc/man-pages/pod1/{fs_listquota.pod => fs_listquota.pod.in} (97%) rename doc/man-pages/pod1/{fs_quota.pod => fs_quota.pod.in} (97%) rename doc/man-pages/pod1/{fs_setquota.pod => fs_setquota.pod.in} (97%) rename doc/man-pages/pod1/{fs_setvol.pod => fs_setvol.pod.in} (98%) rename doc/man-pages/pod1/{vos.pod => vos.pod.in} (99%) rename doc/man-pages/pod1/{vos_clone.pod => vos_clone.pod.in} (98%) rename doc/man-pages/pod1/{vos_create.pod => vos_create.pod.in} (99%) rename doc/man-pages/pod1/{vos_examine.pod => vos_examine.pod.in} (99%) rename doc/man-pages/pod1/{vos_move.pod => vos_move.pod.in} (99%) rename doc/man-pages/pod1/{vos_partinfo.pod => vos_partinfo.pod.in} (98%) rename doc/man-pages/pod1/{vos_shadow.pod => vos_shadow.pod.in} (98%) diff --git a/doc/man-pages/NTMakefile b/doc/man-pages/NTMakefile index 38c12c5ea..a4faf2522 100644 --- a/doc/man-pages/NTMakefile +++ b/doc/man-pages/NTMakefile @@ -355,6 +355,10 @@ clean:: $(CD) html $(DEL) /s *.html $(CD) .. + $(DEL) pod1\fs_listquota.pod + $(DEL) pod1\fs_quota.pod + $(DEL) pod1\fs_setquota.pod + $(DEL) pod1\fs_setvol.pod $(DEL) pod1\pts_adduser.pod $(DEL) pod1\pts_chown.pod $(DEL) pod1\pts_creategroup.pod @@ -373,8 +377,15 @@ clean:: $(DEL) pod1\pts_setmax.pod $(DEL) pod1\pts_sleep.pod $(DEL) pod1\pts_source.pod + $(DEL) pod1\vos.pod $(DEL) pod1\vos_addsite.pod + $(DEL) pod1\vos_clone.pod $(DEL) pod1\vos_copy.pod + $(DEL) pod1\vos_create.pod + $(DEL) pod1\vos_examine.pod + $(DEL) pod1\vos_move.pod + $(DEL) pod1\vos_partinfo.pod + $(DEL) pod1\vos_shadow.pod $(DEL) pod1\vos_zap.pod $(DEL) pod8\dafileserver.pod $(DEL) pod8\dasalvager.pod diff --git a/doc/man-pages/pod1/.gitignore b/doc/man-pages/pod1/.gitignore index 9b024d68e..fc1716f8a 100644 --- a/doc/man-pages/pod1/.gitignore +++ b/doc/man-pages/pod1/.gitignore @@ -2,6 +2,10 @@ # git ls-files -i --exclude-standard # to check that you haven't inadvertently ignored any tracked files. +/fs_listquota.pod +/fs_quota.pod +/fs_setquota.pod +/fs_setvol.pod /pts_adduser.pod /pts_chown.pod /pts_creategroup.pod @@ -20,8 +24,15 @@ /pts_setmax.pod /pts_sleep.pod /pts_source.pod +/vos.pod /vos_addsite.pod /vos_backup.pod /vos_copy.pod +/vos_clone.pod +/vos_create.pod /vos_dump.pod +/vos_examine.pod +/vos_move.pod +/vos_partinfo.pod +/vos_shadow.pod /vos_zap.pod diff --git a/doc/man-pages/pod1/fragments/volsize-caution.pod b/doc/man-pages/pod1/fragments/volsize-caution.pod new file mode 100644 index 000000000..92fa41879 --- /dev/null +++ b/doc/man-pages/pod1/fragments/volsize-caution.pod @@ -0,0 +1 @@ +Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). diff --git a/doc/man-pages/pod1/fs_listquota.pod b/doc/man-pages/pod1/fs_listquota.pod.in similarity index 97% rename from doc/man-pages/pod1/fs_listquota.pod rename to doc/man-pages/pod1/fs_listquota.pod.in index 1a9e5bd9a..f13e5bb0c 100644 --- a/doc/man-pages/pod1/fs_listquota.pod +++ b/doc/man-pages/pod1/fs_listquota.pod.in @@ -30,7 +30,7 @@ To set volume quota, use the B or B command. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/fs_quota.pod b/doc/man-pages/pod1/fs_quota.pod.in similarity index 97% rename from doc/man-pages/pod1/fs_quota.pod rename to doc/man-pages/pod1/fs_quota.pod.in index 30ceb57a6..caa5db18a 100644 --- a/doc/man-pages/pod1/fs_quota.pod +++ b/doc/man-pages/pod1/fs_quota.pod.in @@ -26,7 +26,7 @@ To set volume quota, use the B or B command. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/fs_setquota.pod b/doc/man-pages/pod1/fs_setquota.pod.in similarity index 97% rename from doc/man-pages/pod1/fs_setquota.pod rename to doc/man-pages/pod1/fs_setquota.pod.in index 8eedeedba..416a52dd1 100644 --- a/doc/man-pages/pod1/fs_setquota.pod +++ b/doc/man-pages/pod1/fs_setquota.pod.in @@ -31,7 +31,7 @@ B command. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/fs_setvol.pod b/doc/man-pages/pod1/fs_setvol.pod.in similarity index 98% rename from doc/man-pages/pod1/fs_setvol.pod rename to doc/man-pages/pod1/fs_setvol.pod.in index 414d5a525..fa48fe8ac 100644 --- a/doc/man-pages/pod1/fs_setvol.pod +++ b/doc/man-pages/pod1/fs_setvol.pod.in @@ -38,7 +38,7 @@ To set quota on one volume at a time, use the B command. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos.pod b/doc/man-pages/pod1/vos.pod.in similarity index 99% rename from doc/man-pages/pod1/vos.pod rename to doc/man-pages/pod1/vos.pod.in index 8b2198ac2..8ce7fd425 100644 --- a/doc/man-pages/pod1/vos.pod +++ b/doc/man-pages/pod1/vos.pod.in @@ -128,7 +128,7 @@ and L|vos_help(1)>. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_clone.pod b/doc/man-pages/pod1/vos_clone.pod.in similarity index 98% rename from doc/man-pages/pod1/vos_clone.pod rename to doc/man-pages/pod1/vos_clone.pod.in index 13b6c9fb1..34fdcd653 100644 --- a/doc/man-pages/pod1/vos_clone.pod +++ b/doc/man-pages/pod1/vos_clone.pod.in @@ -58,7 +58,7 @@ B, B, or other B commands. Some commands do not work properly on clone volumes. B is one such command. -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_copy.pod.in b/doc/man-pages/pod1/vos_copy.pod.in index 50cc0a006..dfbfaa6e3 100644 --- a/doc/man-pages/pod1/vos_copy.pod.in +++ b/doc/man-pages/pod1/vos_copy.pod.in @@ -38,7 +38,7 @@ the volume be stored locally by the client. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_create.pod b/doc/man-pages/pod1/vos_create.pod.in similarity index 99% rename from doc/man-pages/pod1/vos_create.pod rename to doc/man-pages/pod1/vos_create.pod.in index 4f1b3c4a0..b99ae4a14 100644 --- a/doc/man-pages/pod1/vos_create.pod +++ b/doc/man-pages/pod1/vos_create.pod.in @@ -66,7 +66,7 @@ mount it in the file space by using the B command. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_examine.pod b/doc/man-pages/pod1/vos_examine.pod.in similarity index 99% rename from doc/man-pages/pod1/vos_examine.pod rename to doc/man-pages/pod1/vos_examine.pod.in index d8d85eab4..0e08fb705 100644 --- a/doc/man-pages/pod1/vos_examine.pod +++ b/doc/man-pages/pod1/vos_examine.pod.in @@ -39,7 +39,7 @@ display information from the VLDB only, use the B command. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_move.pod b/doc/man-pages/pod1/vos_move.pod.in similarity index 99% rename from doc/man-pages/pod1/vos_move.pod rename to doc/man-pages/pod1/vos_move.pod.in index 767807316..28b3cd90a 100644 --- a/doc/man-pages/pod1/vos_move.pod +++ b/doc/man-pages/pod1/vos_move.pod.in @@ -87,7 +87,7 @@ confirmation of the kill signal: To confirm termination of the operation, press Ctrl-C a second time; press any other key to continue the operation. -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_partinfo.pod b/doc/man-pages/pod1/vos_partinfo.pod.in similarity index 98% rename from doc/man-pages/pod1/vos_partinfo.pod rename to doc/man-pages/pod1/vos_partinfo.pod.in index 3af5b1a47..0991ce2c3 100644 --- a/doc/man-pages/pod1/vos_partinfo.pod +++ b/doc/man-pages/pod1/vos_partinfo.pod.in @@ -31,7 +31,7 @@ consulted. =head1 CAUTIONS -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS diff --git a/doc/man-pages/pod1/vos_shadow.pod b/doc/man-pages/pod1/vos_shadow.pod.in similarity index 98% rename from doc/man-pages/pod1/vos_shadow.pod rename to doc/man-pages/pod1/vos_shadow.pod.in index 4987ba298..385215167 100644 --- a/doc/man-pages/pod1/vos_shadow.pod +++ b/doc/man-pages/pod1/vos_shadow.pod.in @@ -57,7 +57,7 @@ containing shadow volumes. This would update the VLDB to show all shadowed Read/Write volumes instead of the source volumes from which they were copied. -Currently, the maximum size of a volume is 2 terabytes (2^31 bytes). +=include fragments/volsize-caution.pod =head1 OPTIONS -- 2.39.5