Page MenuHomeFreeBSD

Add a manual page for the cloudabi and cloudabi64 kernel modules.
ClosedPublic

Authored by ed on Jul 31 2015, 8:54 AM.
Tags
None
Referenced Files
Unknown Object (File)
Jan 10 2025, 11:41 AM
Unknown Object (File)
Jan 8 2025, 12:18 AM
Unknown Object (File)
Jan 1 2025, 12:59 PM
Unknown Object (File)
Dec 29 2024, 9:06 AM
Unknown Object (File)
Nov 7 2024, 2:09 AM
Unknown Object (File)
Nov 3 2024, 6:50 AM
Unknown Object (File)
Nov 3 2024, 6:50 AM
Unknown Object (File)
Nov 3 2024, 6:50 AM
Subscribers

Details

Summary

CloudABI has two separate kernel modules: cloudabi and cloudabi64. The
first module contains all the pointer size independent code, whereas
cloudabi64 contains the actual 64-bits specific system calls and the ELF
loader.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ed retitled this revision from to Add a manual page for the cloudabi and cloudabi64 kernel modules..
ed updated this object.
ed edited the test plan for this revision. (Show Details)
ed added a reviewer: wblock.
share/man/man4/cloudabi.4
34 ↗(On Diff #7541)

Please avoid the informal "you" and "your". Here, it can just be "the" instead of "your".

It is redundant to use "the following" for something that is immediately following.

This sentence can be rearranged to avoid the pause:

Support for 64-bit CloudABI executables can be compiled into the kernel by adding
this line to the kernel configuration file:

51 ↗(On Diff #7541)

Use the serial comma after "test":

easier to test, and hardened against security exploits.

65 ↗(On Diff #7541)

This is a bit vague. What does "assuming" mean here? Is the module assuming all pointers are 64-bit? Is it used in the sense of "converting"? Or does this mean that only 64-bit pointers are handled? Please be specific.

66 ↗(On Diff #7541)

"can" implies that it is not required. Maybe:

It also provides the image activator that loads a 64-bit ELF

67 ↗(On Diff #7541)

That is the correct use of possessive "its", but used twice, it is hard to tell what it refers to. Does the image activator load the executable into the image activator's space, or the executable's space? Possibly this can be simplified, like:

The image activator loads and starts a 64-bit ELF executable.

75 ↗(On Diff #7541)

What does "exists" mean here? Maybe "works", or maybe "is only available for"?

77 ↗(On Diff #7541)

"can be obtained by installing" is simpler as just "is available in"

ed marked 5 inline comments as done.
ed edited edge metadata.

Process feedback by wblock@.

Thanks for the quick response!

share/man/man4/cloudabi.4
34 ↗(On Diff #7541)

Though I agree this can be improved, I actually used this construct because it is present in many other man pages:

$ zgrep -r 'place the following lines in your' /usr/share/man/man4 | wc -l
     282

That said, I don't care too strongly about this. What's your thought?

65 ↗(On Diff #7541)

I've extended this. Does this look better?

share/man/man4/cloudabi.4
35 ↗(On Diff #7551)

That it has been used many times before has also come up before. :) I don't think that's really a very strong argument. In one way, it's an argument against improving. Nor do I think that people are constructing kernel configs by grepping man pages. If they are, we really need a much more strict notation.

Anyway, we are not forced to use the old wording. When there is a chance to eliminate redundancy and pauses, I'll take it. The line I suggested above is still what I prefer.

40 ↗(On Diff #7551)

As above, "the following" is redundant, and the sentence is halted in a couple of places by commas. Consider the alternative:

CloudABI support can also be loaded at boot time from
.Xr loader.conf 5 :

66 ↗(On Diff #7551)

Yes, much better!

ed marked 2 inline comments as done.

Process another round of feedback.

Done! I've changed the synopsis to what you proposed. Looks good!

This revision was automatically updated to reflect the committed changes.