Skip to contentSkip to conversation

Incorrect Overlayfs documentation

DISCUSSION nerdopolis 2 participants 5 messages Jul 16, 2020 – Jan 4, 2021 2 messages not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): 1750303.WlVpaa6DS8.ref@nerdopolis

nerdopolis

author
#1 lore raw

Hi

A while back I opened up https://bugzilla.kernel.org/show_bug.cgi?id=195113 describing a documentation problem in
https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt but for whatever reason, it hasn't been seen.

The problem is that it says "The lower filesystem can be any filesystem supported by Linux" however, this is not the case, as Linux supports vfat, and vfat doesn't work as a lower filesystem

So there's no way to tell what filesystems are applicable for an overlay lowerfs, and I don't think any existing userspace utilities can detect it.

Could it be possible for the .txt file to be updated?

Thanks

#2 lore raw
Quoted 7 lines · nerdopolis

Hi

A while back I opened up https://bugzilla.kernel.org/show_bug.cgi?id=195113 describing a documentation problem in
https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt but for whatever reason, it hasn't been seen.

Quoted 8 lines

The problem is that it says "The lower filesystem can be any filesystem supported by Linux" however, this is not the case, as Linux supports vfat, and vfat doesn't work as a lower filesystem

So there's no way to tell what filesystems are applicable for an overlay lowerfs, and I don't think any existing userspace utilities can detect it.

Could it be possible for the .txt file to be updated?

The way it works usually in this project is you can submit a patch to fix the problem:
https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html

But if you don't want to go through that process, you can offer a text to fix documentation.

But I myself cannot offer anything better than:
"The lower filesystem can be one of many filesystem supported by Linux".

I don't think that we want to start listing the supported filesystems in documentation.

FWIW the description of upper fs isn't uptodate either.

Thanks,
Amir.

author
#3 lore raw
Quoted 28 lines · EDT Amir Goldstein
Quoted 7 lines · nerdopolis

Hi

A while back I opened up https://bugzilla.kernel.org/show_bug.cgi?id=195113 describing a documentation problem in
https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt but for whatever reason, it hasn't been seen.

Quoted 8 lines

The problem is that it says "The lower filesystem can be any filesystem supported by Linux" however, this is not the case, as Linux supports vfat, and vfat doesn't work as a lower filesystem

So there's no way to tell what filesystems are applicable for an overlay lowerfs, and I don't think any existing userspace utilities can detect it.

Could it be possible for the .txt file to be updated?

The way it works usually in this project is you can submit a patch to fix the problem:
https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html

But if you don't want to go through that process, you can offer a text to fix documentation.

But I myself cannot offer anything better than:
"The lower filesystem can be one of many filesystem supported by Linux".

Quoted 9 lines

I don't think that we want to start listing the supported filesystems in documentation.

FWIW the description of upper fs isn't uptodate either.

Thanks,
Amir.

Hi.

Yeah, that process might be cumbersome. I guess what you have is good. Maybe "A wide range of filesystems supported by Linux can be the lower filesystem, however, not all filesystems that are mountable by Linux have the features needed for OverlayFS to work"
?

Thanks

#4 lore raw
Quoted 39 lines · nerdopolis
Quoted 28 lines · EDT Amir Goldstein
Quoted 7 lines · nerdopolis

Hi

A while back I opened up https://bugzilla.kernel.org/show_bug.cgi?id=195113 describing a documentation problem in
https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt but for whatever reason, it hasn't been seen.

Quoted 8 lines

The problem is that it says "The lower filesystem can be any filesystem supported by Linux" however, this is not the case, as Linux supports vfat, and vfat doesn't work as a lower filesystem

So there's no way to tell what filesystems are applicable for an overlay lowerfs, and I don't think any existing userspace utilities can detect it.

Could it be possible for the .txt file to be updated?

The way it works usually in this project is you can submit a patch to fix the problem:
https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html

But if you don't want to go through that process, you can offer a text to fix documentation.

But I myself cannot offer anything better than:
"The lower filesystem can be one of many filesystem supported by Linux".

Quoted 9 lines

I don't think that we want to start listing the supported filesystems in documentation.

FWIW the description of upper fs isn't uptodate either.

Thanks,
Amir.

Quoted 8 lines

Hi.

Yeah, that process might be cumbersome. I guess what you have is good. Maybe "A wide range of filesystems supported by Linux can be the lower filesystem, however, not all filesystems that are mountable by Linux have the features needed for OverlayFS to work"
?

That sounds good to me.

CC the maintainer in case he wants to apply this documentation "patch" himself.

Thanks,
Amir.

A message that is not in the archive (sent off-list or not yet received): CAH2+hP4=9A2fWkJgJhUZps+5gCqZfPSzfNJDXW3FHjDZmk3-vA@mail.gmail.com

author
#6 lore raw
Quoted 72 lines · EST Marco Nelissen
Quoted 61 lines · Amir Goldstein
Quoted 8 lines · nerdopolis
Quoted 6 lines · EDT Amir Goldstein
Quoted 4 lines · nerdopolis

Hi

A while back I opened up

https://bugzilla.kernel.org/show_bug.cgi?id=195113 describing a documentation problem in

Quoted 1 line
Quoted 1 line
Quoted 1 line

https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt

but for whatever reason, it hasn't been seen.

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

The problem is that it says "The lower filesystem can be any

filesystem supported by Linux"

Quoted 1 line
Quoted 1 line
Quoted 1 line

however, this is not the case, as Linux supports vfat, and vfat

doesn't work as a lower filesystem

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

So there's no way to tell what filesystems are applicable for an

overlay lowerfs,

Quoted 6 lines
Quoted 6 lines
Quoted 4 lines

and I don't think any existing userspace utilities can detect it.

Could it be possible for the .txt file to be updated?

The way it works usually in this project is you can submit a patch to

fix the

Quoted 4 lines
Quoted 4 lines

problem:
https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html

But if you don't want to go through that process, you can offer a text

to

Quoted 4 lines
Quoted 4 lines

fix documentation.

But I myself cannot offer anything better than:
"The lower filesystem can be one of many filesystem supported by

Linux".

Quoted 2 lines
Quoted 2 lines

I don't think that we want to start listing the supported filesystems

in

Quoted 8 lines
Quoted 8 lines

documentation.

FWIW the description of upper fs isn't uptodate either.

Thanks,
Amir.

Quoted 5 lines

Hi.

Yeah, that process might be cumbersome. I guess what you have is good. Maybe "A wide range of filesystems supported by Linux can be the lower filesystem, however, not all filesystems that are mountable by Linux

have the

Quoted 3 lines

features needed for OverlayFS to work"
?

Quoted 8 lines

That sounds good to me.

CC the maintainer in case he wants to apply this documentation "patch" himself.

Thanks,
Amir.

Quoted 7 lines

A documentation patch was submitted for this a few months ago (
https://github.com/torvalds/linux/commit/58afaf5d605f091abf7491774e34fa29d4a1994c)
however I think the sentence "A read-only overlay of two read-only filesystems may use any filesystem type." should also be removed or rewritten, since a read-only vfat fs still can't be used in an overlay as far as I can tell.

Yeah, testing on a read-only vfat filesystem as the lowerdir and it doesn't work Something to do with dentry's and ovl_dentry_weird. I don't think there's any way to determine that with a userspace utility or not.