Add a fusefs(5) man page
PR: 233393
Details
Details
- Reviewers
cem - Group Reviewers
manpages - Commits
- rS351946: MFC r346186:
rS346186: fusefs: add a fusefs(5) man page
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
Thanks for doing this. We've needed a page for a while. Have you run it past the igor tool?
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 46 ↗ | (On Diff #55253) | It's just "fuse" |
| 51–52 ↗ | (On Diff #55253) | This sentence doesn't really add anything (IMO) |
| 53–56 ↗ | (On Diff #55253) | Grammar here is off and I'm not sure this sentence adds anything |
| 147 ↗ | (On Diff #55253) | arao@ |
| 150–153 ↗ | (On Diff #55253) | Oh? |
Comment Actions
Sorry, I do not master Phabricator…
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 55 ↗ | (On Diff #55253) | s/implemented/implementing |
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 72 ↗ | (On Diff #55259) | Isn't that pretty obvious, for these two? |
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 122 ↗ | (On Diff #55259) | I’d discourage use of .Po and .Pc. Why make it harder to read? |
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 122 ↗ | (On Diff #55259) | I have no opinion. You two please sort it out amongst yourselves; I'll go either way. |
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 122 ↗ | (On Diff #55259) | |
Comment Actions
Please just use ordinary parentheses. The macros make pages harder to read and provide no benefit. As you note, plain parens are the vastly predominant style. I, too, would be curious why @bjk suggests using the macros.
Comment Actions
I was under impression that macros should be used when normal parentheses could not be, because of another nearby macro would garble formatting. Something like when closing parenthesis follows another macro, there'd be an extra space inserted before it, and to avoid this, one uses macros.
That said, I'd also like to hear a definitive answer from the doc team.
Comment Actions
That makes sense, @danfe . In this case the closing paren immediately follows the .Xr macro.
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 49 ↗ | (On Diff #55269) | I recall that several years ago, we (as a project) have decided to use separate words (file system) rather than filesystem, see e.g. tunefs(8) et al. You might want to consider this, and/or ask someone who knows these bylaws better. |
| 70 ↗ | (On Diff #55269) | ABI is an abbreviation and thus should be uppercased. Ditto below. |
Comment Actions
Provide a link to the (small) word list in the FDP.
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 49 ↗ | (On Diff #55269) | We keep a small word list here: |
| share/man/man5/fusefs.5 | ||
|---|---|---|
| 53 ↗ | (On Diff #55492) | I'd suggest simplifying this sentence by removing the first clause and starting the next with "Userspace daemons can …". Suggest "or even" -> plain "or". (Or perhaps @bcr's wordlist implies "Userland" is preferred to "Userspace." Either way.) |
| 54 ↗ | (On Diff #55492) | I might chop off everything after "languages." in this sentence. The object of contrast (kernel) is implied by the "userspace" characterization above. There's also some philosophical nitpick argument about programming languages not necessarily being unable to run in the kernel, but I don't feel that argument should be weighed too heavily :-). |
| 122 ↗ | (On Diff #55492) | ( |
| 124 ↗ | (On Diff #55492) | .Xr … ) renders correctly and use of trailing symbols is extremely common. (E.g., trailing commas in .Sh SEE ALSO section Xr lists.) |
| 49 ↗ | (On Diff #55269) | Thanks, @bcr. |