Re: [PATCH 05/10] fsconfig.2: document 'new' mount api
From: Askar Safin <hidden>
Date: 2025-08-06 11:47:06
---- On Wed, 06 Aug 2025 12:33:03 +0400 Aleksa Sarai [off-list ref] wrote --- > I intentionally tried to avoid using the term "superblock" as much as > possible, because the term is not generally used nor well understood by > userspace. The kernel terminology for it is even more fraught with > ambiguity because the closest thing approximating common usage of > "superblock" in userspace is the on-disk concept of a "superblock"[2] -- > which doesn't make sense to refer to when talking about runtime > filesystem parameters. Kernel developers, of course, are referring to > something completely different -- a _conceptual_ "struct super_block" > that has little to do with the on-disk kind. > > If we rely on the term, we would probably need to add a superblock(7) to > describe what a superblock is, which is a much larger documentation > topic than just the "new" mount API. It's not really enough to just > define it at the top of the fsopen(2) man page (as you suggested), > because most of the other man pages would need to cross-reference it. > > The compromise I came up with was to use "mount object" when referring > to mounts (read: "struct (vfs)mount"), "filesystem configuration > context" or "filesystem context" when talking about "struct fs_context", > and "filesystem instance" when talking about "struct super". Those > seemed more self-descriptive to me, which would hopefully let me avoid > having to write 3 extra man7 pages. Though to be honest, I'm still not > sure that "filesystem context" is a sufficiently helpful term here, even > with the introductory paragraph in fsopen(2). I agree. > In this case, this should probably read "filesystem instance" but that > sounded strange to me when the comparison we use is with mount(2) which > uses the term "mount" for the same operation. I wasn't sure whether to > go with what users are more familiar with in an EXAMPLES section, or to > use the more common words. I guess there's a stronger argument to go > with "filesystem instance" here... I still think that "parameters of an existing mount" should be changed to "parameters of an existing filesystem instance". Yes, I agree that no major changes should be done to manpages, but I kindly ask you fix this particular sentence. I still think that difference between mount and filesystem instance is important. Also, if mount(2) manpage confuses these terms, then it should be changed, too. (Of course, this doesn't mean that you should change it. I just mean that somebody should change it.) -- Askar Safin https://types.pl/@safinaskar