Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

msdosfs manuals: describe and link better #1501

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

concussious
Copy link
Contributor

@concussious concussious commented Oct 27, 2024

Increase accessibility of msdosfs subsystem by linking all msdosfs utility manuals to msdosfs(4), linking msdosfs(4) to all of them, and rewriting the document descriptions for consistency with other documentation.

Regarding the removal of MSDOS and window, the former is already in the search keywords from the title. The latter hasn't been true in 20 years. The file allocation table fs is used widely in embedded devices, and i think normal people are going to search for it that way. If someone is searching for "windows" in the context of filesystems, they certainly want ntfs-3g or... are wrong.

While here, remove fsck_ufs(8) from fsck_msdosfs(8). It's already linked to fsck(8) if the reader is at the wrong page.

These filesystems and their manuals have worked great for me for a long time. Thanks!

+ xref msdosfs(4) to all msdosfs pages, and xref them all back
+ add name of filesystem and popular abreviation to all descriptions
- remove long irrelevant DOS/Windows from description/search keywords
- remove fsck_ffs(8) from fsck_msdos(8)

MFC after:	3 days
@jlduran
Copy link
Member

jlduran commented Nov 13, 2024

I like this pull request, however I would reconsider leaving the words MS-DOS and Windows in place.

@concussious
Copy link
Contributor Author

concussious commented Nov 13, 2024

Thank you. msdos is already included from the name, so if the user searches for dos, these pages will all come up. Windows is a different story, I think it must be dropped. For people under 40, file allocation table is known as the embedded devices filesystem, where it is widely deployed. It stopped being the default in Windows NT 3.1 (31 years ago) and Windows XP (23 years ago). Therefore, I do not think it is reasonable that anyone will be looking for these tools by searching with apropos windows.

Perhaps another consideration towards this is that the spec for a document description is one line about what it does. In my opinion, exceeding one line in standard console makes a mess and should be a last resort.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants