ovl: document lower modification caveats
authorKevin Locke <kevin@kevinlocke.name>
Sun, 23 Aug 2020 02:22:57 +0000 (20:22 -0600)
committerMiklos Szeredi <mszeredi@redhat.com>
Thu, 12 Nov 2020 10:31:55 +0000 (11:31 +0100)
commit13c6ad0f45fd0382e77829a6c738f3e18739c15b
tree7c926f0614d1efdcebabbb6893ae0acedffbc93d
parent0a8d0b64dd6acfbc9e9b79022654bbe1ade4a29a
ovl: document lower modification caveats

Some overlayfs optional features are incompatible with offline changes to
the lower tree and may result in -EXDEV, -EIO, or other errors.  Such
modification is not supported and the error behavior is intentionally not
specified.

Update the "Changes to underlying filesystems" section to note this
restriction.  Move the paragraph describing the offline behavior below the
online behavior so it is adjacent to the following 3 paragraphs describing
the NFS export offline modification behavior.

Link: https://lore.kernel.org/linux-unionfs/20200708142353.GA103536@redhat.com/
Link: https://lore.kernel.org/linux-unionfs/CAOQ4uxi23Zsmfb4rCed1n=On0NNA5KZD74jjjeyz+et32sk-gg@mail.gmail.com/
Link: https://lore.kernel.org/linux-unionfs/20200817135651.GA637139@redhat.com/
Link: https://lore.kernel.org/linux-unionfs/20200709153616.GE150543@redhat.com/
Link: https://lore.kernel.org/linux-unionfs/20200812135529.GA122370@kevinolos/
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Signed-off-by: Miklos Szeredi <mszeredi@redhat.com>
Documentation/filesystems/overlayfs.rst