freebsd
man: Move filesystems to section 4
msdosfs.5 is not a file format, so move it to section 4 edit document description to increase visibility clarify capabilities in description tidy grammar in the first example link newfs_msdos and fsck_msdosfs
2 commits to facilitate review ok for this type of change? thanks everyone
EDIT: Eventually this became moving filesystems to section 4, with the minimum cleaning that I couldn't resist.
Note there are many filesystems in section 5; we don't want to treat msdos.5 differently from the others. I'm not sure if it's better to rename section 5 to include filesystems or move all of them.
cd9660.5 ext2fs.5 fusefs.5 linprocfs.5 linsysfs.5 mqueuefs.5 msdosfs.5 nullfs.5 smbfs.5 tarfs.5 tmpfs.5 unionfs.5
Note there are many filesystems in section 5; we don't want to treat msdos.5 differently from the others.
Agree. Please excuse me, I didn't see those.
I'm not sure if it's better to rename section 5 to include filesystems or move all of them.
I believe my perspective, coming from a background without formal education but consistently using BSD since early childhood, is valuable for this discussion. I find it elegant and logical to group drivers together. As a humble handyman and taiji coach, I wondered, 'How did I never notice this driver page in Section 5? It should be with the other drivers.' Upon closer inspection of intro(4), it only specifies 'device' drivers.
If there's a consensus, I'd be honored to move the rest to Section 4 and make adjustments to intro.4 and man.1 accordingly.
Maybe this kind of change would be better discussed on a differential? I created an account some months ago, but I haven't quite figured out how to use it yet.
Note there are many filesystems in section 5; we don't want to treat msdos.5 differently from the others. I'm not sure if it's better to rename section 5 to include filesystems or move all of them.
cd9660.5 ext2fs.5 fusefs.5 linprocfs.5 linsysfs.5 mqueuefs.5 msdosfs.5 nullfs.5 smbfs.5 tarfs.5 tmpfs.5 unionfs.5
I kinda think we should move these. Section 5 is file formats, and most of the file format are there. All these documents are not about the format of these filesysttems, but how to configure them for the kernel. And that's section 4: All the drivers and other kernel modules are described there.
But one thing I noticed when I was staging this... msdosfs.5 wasn't remove from share/man/man5/Makefile, nor msdosfs.4 added to share/man/man4/Makefile. That would need to be corrected. And you should do it in the first.
Neither NetBSD nor OpenBSD have these in man5. In fact, the options are described elsewhere that I'm having trouble finding.
But one thing I noticed when I was staging this... msdosfs.5 wasn't remove from share/man/man5/Makefile, nor msdosfs.4 added to share/man/man4/Makefile. That would need to be corrected. And you should do it in the first.
Oops, thank you. Fixed in latest push.
Edit: should this page be built only if msdosfs is enabled?
Can you split out the changes that aren't directly related to the move into a separate commit (I tagged one, then saw a lot then saw your commit message)? Most of them don't look like they change more than markup, so it's good you've not bumped the dates (which can be a real pain to merge). I think after that, it will be ready.
I didn't change any of the docdates this time. I'd like to add something to style.mdoc about not bumping docdates if it makes it harder for committers.
Should contributors always save bumping docdate for the committer?
Should contributors always save bumping docdate for the committer?
I think so on github, though that's poorly documented. And we don't have a nice script that will just do it for everything in the commit. This time, though, ir does make sense.
I think this is ready, but I want to do a final look over in my staging area.
I'm sorry, looking over it again: the "CD" I added to cd9660.4 is unhelpful because CD is already a valid search term from Nm; so I switched it to "disc", because it seems reasonable to search for disc sometimes.
My proposed addition of "driver" to msdosfs.4 isn't appropriate or consistent, if it's being moved to (4), a 4 will appear in the listing denoting it's drivership.
Latest push fixes these two issues and a markup consolidation.
Hmmm, since we're moving all these files, I think we need ObsoleteFiles.inc changes, no? Sorry I didn't think of it sooner.
we need ObsoleteFiles.inc changes
I think I also need to grep all pages in the manual for xrefs to these pages and fix them, right?
we need ObsoleteFiles.inc changes
I think I also need to grep all pages in the manual for xrefs to these pages and fix them, right?
Yes please.
Sorry, I understand this is unreviewable and I need to break it up more, but I wanted to get what I had up for now.
After reflecting on your example this morning, I decided to narrow it even further to just the move. Thanks for everything.
Are you still working on this, or were the pushes just the moves... I didn't see anything stray, but I wanted to check
Are you still working on this
I believe it's ready. Thank you for your patience.