doc: Consolidate CAUTIONS notes about volume size
authorAndrew Deason <adeason@sinenomine.net>
Thu, 28 Jun 2012 20:30:40 +0000 (15:30 -0500)
committerJeffrey Altman <jaltman@your-file-system.com>
Tue, 3 Jul 2012 14:30:17 +0000 (07:30 -0700)
Change-Id: I264906fb3f61db62c483982f613654a9a897f417
Reviewed-on: http://gerrit.openafs.org/7597
Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com>
Tested-by: Jeffrey Altman <jaltman@your-file-system.com>

15 files changed:
doc/man-pages/NTMakefile
doc/man-pages/pod1/.gitignore
doc/man-pages/pod1/fragments/volsize-caution.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_listquota.pod.in [moved from doc/man-pages/pod1/fs_listquota.pod with 97% similarity]
doc/man-pages/pod1/fs_quota.pod.in [moved from doc/man-pages/pod1/fs_quota.pod with 97% similarity]
doc/man-pages/pod1/fs_setquota.pod.in [moved from doc/man-pages/pod1/fs_setquota.pod with 97% similarity]
doc/man-pages/pod1/fs_setvol.pod.in [moved from doc/man-pages/pod1/fs_setvol.pod with 98% similarity]
doc/man-pages/pod1/vos.pod.in [moved from doc/man-pages/pod1/vos.pod with 99% similarity]
doc/man-pages/pod1/vos_clone.pod.in [moved from doc/man-pages/pod1/vos_clone.pod with 98% similarity]
doc/man-pages/pod1/vos_copy.pod.in
doc/man-pages/pod1/vos_create.pod.in [moved from doc/man-pages/pod1/vos_create.pod with 99% similarity]
doc/man-pages/pod1/vos_examine.pod.in [moved from doc/man-pages/pod1/vos_examine.pod with 99% similarity]
doc/man-pages/pod1/vos_move.pod.in [moved from doc/man-pages/pod1/vos_move.pod with 99% similarity]
doc/man-pages/pod1/vos_partinfo.pod.in [moved from doc/man-pages/pod1/vos_partinfo.pod with 98% similarity]
doc/man-pages/pod1/vos_shadow.pod.in [moved from doc/man-pages/pod1/vos_shadow.pod with 98% similarity]

index 38c12c5..a4faf25 100644 (file)
@@ -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
index 9b024d6..fc1716f 100644 (file)
@@ -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
 /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 (file)
index 0000000..92fa418
--- /dev/null
@@ -0,0 +1 @@
+Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
similarity index 97%
rename from doc/man-pages/pod1/fs_listquota.pod
rename to doc/man-pages/pod1/fs_listquota.pod.in
index 1a9e5bd..f13e5bb 100644 (file)
@@ -30,7 +30,7 @@ To set volume quota, use the B<fs setquota> or B<fs setvol> command.
 
 =head1 CAUTIONS
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
similarity index 97%
rename from doc/man-pages/pod1/fs_quota.pod
rename to doc/man-pages/pod1/fs_quota.pod.in
index 30ceb57..caa5db1 100644 (file)
@@ -26,7 +26,7 @@ To set volume quota, use the B<fs setquota> or B<fs setvol> command.
 
 =head1 CAUTIONS
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
similarity index 97%
rename from doc/man-pages/pod1/fs_setquota.pod
rename to doc/man-pages/pod1/fs_setquota.pod.in
index 8eedeed..416a52d 100644 (file)
@@ -31,7 +31,7 @@ B<fs quota> command.
 
 =head1 CAUTIONS
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
similarity index 98%
rename from doc/man-pages/pod1/fs_setvol.pod
rename to doc/man-pages/pod1/fs_setvol.pod.in
index 414d5a5..fa48fe8 100644 (file)
@@ -38,7 +38,7 @@ To set quota on one volume at a time, use the B<fs setquota> command.
 
 =head1 CAUTIONS
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
similarity index 99%
rename from doc/man-pages/pod1/vos.pod
rename to doc/man-pages/pod1/vos.pod.in
index 8b2198a..8ce7fd4 100644 (file)
@@ -128,7 +128,7 @@ and L<B<vos help>|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
 
similarity index 98%
rename from doc/man-pages/pod1/vos_clone.pod
rename to doc/man-pages/pod1/vos_clone.pod.in
index 13b6c9f..34fdcd6 100644 (file)
@@ -58,7 +58,7 @@ B<vos move>, B<vos dump>, or other B<vos> commands.
 Some commands do not work properly on clone volumes. B<vos move> is one
 such command.
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
index 50cc0a0..dfbfaa6 100644 (file)
@@ -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
 
similarity index 99%
rename from doc/man-pages/pod1/vos_create.pod
rename to doc/man-pages/pod1/vos_create.pod.in
index 4f1b3c4..b99ae4a 100644 (file)
@@ -66,7 +66,7 @@ mount it in the file space by using the B<fs mkmount> command.
 
 =head1 CAUTIONS
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
similarity index 99%
rename from doc/man-pages/pod1/vos_examine.pod
rename to doc/man-pages/pod1/vos_examine.pod.in
index d8d85ea..0e08fb7 100644 (file)
@@ -39,7 +39,7 @@ display information from the VLDB only, use the B<vos listvldb> command.
 
 =head1 CAUTIONS
 
-Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
+=include fragments/volsize-caution.pod
 
 =head1 OPTIONS
 
similarity index 99%
rename from doc/man-pages/pod1/vos_move.pod
rename to doc/man-pages/pod1/vos_move.pod.in
index 7678073..28b3cd9 100644 (file)
@@ -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
 
similarity index 98%
rename from doc/man-pages/pod1/vos_partinfo.pod
rename to doc/man-pages/pod1/vos_partinfo.pod.in
index 3af5b1a..0991ce2 100644 (file)
@@ -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
 
similarity index 98%
rename from doc/man-pages/pod1/vos_shadow.pod
rename to doc/man-pages/pod1/vos_shadow.pod.in
index 4987ba2..3852151 100644 (file)
@@ -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