man: move filesystems to section 4 #1077
Conversation
concussious
force-pushed
the
patch-2
branch
2 times, most recently
from
d194348
to
28e78e6
Compare
|
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 |
Agree. Please excuse me, I didn't see those.
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. |
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. |
Oops, thank you. Fixed in latest push. Edit: should this page be built only if msdosfs is enabled? |
concussious
changed the title
concussious
force-pushed
the
patch-2
branch
5 times, most recently
from
260c082
to
a9fc074
Compare
sbin/fsck_ffs/fsck_ffs.8
Outdated
| @@ -31,7 +33,8 @@ | |||
| .Os | |||
| .Sh NAME | |||
| .Nm fsck_ffs , | |||
| .Nm fsck_ufs | |||
| .Nm fsck_ufs , | |||
| .Nm fsck_4.2bsd | |||
There was a problem hiding this comment.
This looks to be a separate change... Can you split it out into its own commit?
|
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 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? |
concussious
force-pushed
the
patch-2
branch
2 times, most recently
from
7a31e21
to
23ec942
Compare
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. |
Reported by: imp Pull Request: freebsd#1077
concussious
changed the title
|
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 |
Filesystem manual pages describe drivers, not formats; except for fs, which describes the structures of ffs/ufs. Reported by: emaste Reviewed by: des, imp, meena (previous version) Pull Request: freebsd#1077
Reported by: des, imp Pull Request: freebsd#1077
Reviewed by: des, imp Pull Request: freebsd#1077
I believe it's ready. Thank you for your patience. |
Filesystem manual pages describe drivers, not formats; except for fs, which describes the structures of ffs/ufs. Reported by: emaste Reviewed by: des, imp, meena (previous version) Pull Request: freebsd#1077
Reported by: imp Reviewed by: des, imp Pull Request: freebsd#1077
Reviewed by: des, imp Pull Request: freebsd#1077
Filesystem manual pages describe drivers, not formats; except for fs, which describes the structures of ffs/ufs, not how to use it in the system. Reported by: emaste Reviewed by: des, imp, meena (previous version) Pull Request: freebsd#1077
Reported by: imp Reviewed by: des, imp Pull Request: freebsd#1077
Reviewed by: des, imp Pull Request: freebsd#1077
This was originally inspired by some cleanups and clarifications for msdosfs, which will be saved for another PR.