openafs/doc/man-pages/pod1
Mark Vitale 8e1c321dc8 volser: document 'vos restore -readonly' restriction
Commit 0c03f8607e vos-command-enhancements-20011008 introduced the
'vos restore' -readonly option, which allows the restored volume to be
RO instead of the default RW.  The commit message documents the
following restriction:

- ... This option causes the restored volume to be an RO volume.  It is
  not permitted to restore an RO volume when the associated RW volume
  already exists.  While it is possible to restore an RW volume where an
  RO volume exists, caution should be used to avoid doing this with VLDB
  entries created by 'vos restore -readonly', since such entries have
  their ROVOL and RWVOL ID's set to the same thing.

Document this restriction in the 'vos restore' man page, and in a code
comment.

No functional change is incurred by this commit.

Change-Id: I34f6c5434b82da538a38a9d219207b33dcf62b17
Reviewed-on: https://gerrit.openafs.org/14348
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
2020-11-13 10:35:15 -05:00
..
fragments doc: vos manpage fixes 2013-11-04 09:32:48 -08:00
.gitignore vos: remaddrs sub-command 2015-03-22 13:12:57 -04:00
afs_compile_et.pod comerr: compile_et -emit option for parallel make 2014-01-29 07:20:44 -08:00
afs.pod doc: the last partition name is /vicepiu 2018-09-14 08:35:26 -04:00
afsmonitor.pod doc: document the version subcommand 2015-11-12 11:29:37 -05:00
aklog.pod aklog: require opt-in to enable single-DES in libkrb5 2019-07-17 17:40:16 -04:00
cmdebug.pod doc: -afsdb uses SRV records 2011-05-17 13:20:26 -07:00
copyauth.pod man-page-copyauth-20090518 2009-05-18 19:32:06 +00:00
dlog.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_apropos.pod man-page-name-underscore-more-20071111 2007-11-12 00:12:28 +00:00
fs_bypassthreshold.pod doc: Add fs bypassthreshold man page 2012-07-05 20:50:50 -07:00
fs_checkservers.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_checkvolumes.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_chgrp.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_chown.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_cleanacl.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_copyacl.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_cscpolicy.pod manpages-fs-chown-chgrp-20090701 2009-07-01 22:12:10 +00:00
fs_discon.pod doc: Add 'fs discon' manpage 2013-11-04 12:21:27 -08:00
fs_diskfree.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_examine.pod doc: fs examine no longer requires read rights on the volume root vnode 2016-03-19 15:53:03 -04:00
fs_exportafs.pod doc: fs manpage fixes 2013-11-04 04:09:26 -08:00
fs_flush.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_flushall.pod libafs: fs flushall for unix cm 2013-01-24 08:35:40 -08:00
fs_flushmount.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_flushvolume.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_getcacheparms.pod Document the extra options to fs getcacheparms 2010-02-03 07:53:24 -08:00
fs_getcalleraccess.pod man-page-license-change-20071225 2007-12-25 22:22:22 +00:00
fs_getcellstatus.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_getclientaddrs.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_getcrypt.pod Fix spelling error in fs_getcrypt man page 2013-06-18 11:33:42 -07:00
fs_getfid.pod doc: fs manpage fixes 2013-11-04 04:09:26 -08:00
fs_getserverprefs.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_getverify.pod Fix spelling error in fs_getverify man page 2013-06-29 23:27:41 -07:00
fs_help.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_listacl.pod Remove references to IBM AFS 2010-05-26 12:05:45 -07:00
fs_listaliases.pod spelling/grammar fixes for manpages 2011-02-03 12:29:34 -08:00
fs_listcells.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_listquota.pod.in doc: Document fs listquota 2TB partition limit 2014-12-03 01:02:20 -05:00
fs_lsmount.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_memdump.pod manpages-fs-chown-chgrp-20090701 2009-07-01 22:12:10 +00:00
fs_messages.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_minidump.pod Docs: Specify where the Windows mini dump file is written 2010-11-02 20:29:01 -07:00
fs_mkmount.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_monitor.pod man-page-fs-monitor-20090518 2009-05-18 19:35:31 +00:00
fs_newalias.pod doc: fix a nit in fs_newalias.pod 2013-12-18 07:37:05 -08:00
fs_newcell.pod doc: add linked cells description to man pages 2013-11-01 18:53:13 -07:00
fs_nukenfscreds.pod doc: Add 'fs nukenfscreds' manpage 2013-11-04 12:20:58 -08:00
fs_precache.pod doc: Add 'fs precache' manpage 2013-11-04 12:20:29 -08:00
fs_quota.pod.in doc: Fix whitespace errors 2012-07-03 07:30:39 -07:00
fs_rmmount.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_rxstatpeer.pod man-page-yet-more-fs-commands-20090517 2009-05-18 04:34:38 +00:00
fs_rxstatproc.pod doc: fs manpage fixes 2013-11-04 04:09:26 -08:00
fs_setacl.pod doc: fix typo in fs setacl 2014-01-22 17:51:12 -08:00
fs_setcachesize.pod Document human-readable size suffixes 2009-07-25 07:10:52 -07:00
fs_setcbaddr.pod doc: fs manpage fixes 2013-11-04 04:09:26 -08:00
fs_setcell.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_setclientaddrs.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
fs_setcrypt.pod doc: clarify setcrypt defaults 2013-08-02 08:58:56 -07:00
fs_setquota.pod.in doc: Consolidate CAUTIONS notes about volume size 2012-07-03 07:30:17 -07:00
fs_setserverprefs.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_setverify.pod man-pages: add fs_getverify and fs_setverify 2012-01-29 13:54:36 -08:00
fs_setvol.pod.in doc: Consolidate CAUTIONS notes about volume size 2012-07-03 07:30:17 -07:00
fs_storebehind.pod doc: fix some broken link specifications 2011-06-22 11:01:09 -07:00
fs_sysname.pod Remove support for Solaris pre-8 2011-06-30 07:27:39 -07:00
fs_trace.pod man-page-syntax-errors-20090518 2009-05-19 00:53:26 +00:00
fs_uuid.pod man-page-license-change-20071225 2007-12-25 22:22:22 +00:00
fs_whereis.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
fs_whichcell.pod doc: fs manpage fixes 2013-11-04 04:09:26 -08:00
fs_wscell.pod doc: clarify the fs wscell manpage 2017-03-02 22:38:59 -05:00
fs.pod doc: document the version subcommand 2015-11-12 11:29:37 -05:00
klog.krb5.pod aklog: require opt-in to enable single-DES in libkrb5 2019-07-17 17:40:16 -04:00
klog.pod doc: state klog.krb is obsolete 2013-09-30 06:31:56 -07:00
knfs.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
kpasswd.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
livesys.pod doc: Fix livesys output formatting 2013-11-04 12:18:48 -08:00
pagsh.pod doc: fix some broken link specifications 2011-06-22 11:01:09 -07:00
pts_adduser.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_apropos.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
pts_chown.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_creategroup.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_createuser.pod.in Disallow creating users with ANONYMOUSID 2014-11-22 21:37:27 -05:00
pts_delete.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_examine.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_help.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
pts_interactive.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_listentries.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_listmax.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_listowned.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_membership.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_quit.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_removeuser.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_rename.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_setfields.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_setmax.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_sleep.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts_source.pod.in doc: pts manpage fixes 2013-11-03 20:36:16 -08:00
pts.pod doc: Document new rxgk options 2020-01-08 00:15:42 -05:00
restorevol.pod doc: restorevol manpage fixes 2013-11-04 04:09:12 -08:00
rxdebug.pod doc: rxdebug manpage fixes 2013-11-04 11:57:07 -08:00
rxgen.pod Remove unused xdr types 2020-11-06 14:29:37 -05:00
scout.pod doc: document the version subcommand 2015-11-12 11:29:37 -05:00
symlink_list.pod manpages-fs-chown-chgrp-20090701 2009-07-01 22:12:10 +00:00
symlink_make.pod manpages-fs-chown-chgrp-20090701 2009-07-01 22:12:10 +00:00
symlink_remove.pod manpages-fs-chown-chgrp-20090701 2009-07-01 22:12:10 +00:00
symlink.pod Add POD links (L<>) in pts.pod and symlink.pod 2009-10-08 11:00:14 -07:00
sys.pod Remove support for Solaris pre-8 2011-06-30 07:27:39 -07:00
tokens.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
translate_et.pod pretty-html-synopsis-20060228 2006-03-01 05:02:29 +00:00
udebug.pod doc: Fix udebug -port bullet list 2013-11-03 20:36:42 -08:00
unlog.pod doc: replace hostnames with IETF example hostnames 2012-02-17 20:51:58 -08:00
up.pod pretty-html-synopsis-20060228 2006-03-01 05:02:29 +00:00
vos_addsite.pod.in doc: vos manpage fixes 2013-11-04 09:32:48 -08:00
vos_apropos.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
vos_backup.pod.in doc: vos manpage fixes 2013-11-04 09:32:48 -08:00
vos_backupsys.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_changeaddr.pod.in vos: changeaddr refuse to change mh entries without -force 2015-07-24 00:29:32 -04:00
vos_changeloc.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_clone.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_convertROtoRW.pod.in doc: recommend cleanup steps in "vos convertROtoRW" man page 2014-04-23 21:54:07 -07:00
vos_copy.pod.in doc: vos manpage fixes 2013-11-04 09:32:48 -08:00
vos_create.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_delentry.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_dump.pod.in doc: vos manpage fixes 2013-11-04 09:32:48 -08:00
vos_endtrans.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_examine.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_help.pod man-page-name-underscore-20071111 2007-11-11 22:54:56 +00:00
vos_listaddrs.pod.in vos: remaddrs sub-command 2015-03-22 13:12:57 -04:00
vos_listpart.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_listvldb.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_listvol.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_lock.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_move.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_offline.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_online.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_partinfo.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_release.pod.in vos: desupport -stayonline 2015-06-16 13:51:59 -04:00
vos_remaddrs.pod.in vos: remaddrs sub-command 2015-03-22 13:12:57 -04:00
vos_remove.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_remsite.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_rename.pod.in vos: fix name availability check in vos rename 2020-01-31 12:54:51 -05:00
vos_restore.pod.in volser: document 'vos restore -readonly' restriction 2020-11-13 10:35:15 -05:00
vos_setaddrs.pod.in vos: remaddrs sub-command 2015-03-22 13:12:57 -04:00
vos_setfields.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_shadow.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_size.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_status.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_syncserv.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_syncvldb.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_unlock.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_unlockvldb.pod.in doc: Make all vos pages =include common options 2013-11-04 09:32:57 -08:00
vos_zap.pod.in doc: vos manpage fixes 2013-11-04 09:32:48 -08:00
vos.pod.in doc: Document new rxgk options 2020-01-08 00:15:42 -05:00
xstat_cm_test.pod doc: document the version subcommand 2015-11-12 11:29:37 -05:00
xstat_fs_test.pod xstat: prevent CPU loop when -period 0 2020-10-23 11:41:30 -04:00