Page MenuHomeFreeBSD

Upgrade FreeBSD features page
ClosedPublic

Authored by carlavilla on Jul 14 2022, 8:45 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Apr 8, 1:15 PM
Unknown Object (File)
Mon, Apr 8, 12:24 PM
Unknown Object (File)
Nov 11 2023, 9:32 PM
Unknown Object (File)
Nov 11 2023, 11:01 AM
Unknown Object (File)
Nov 11 2023, 4:35 AM
Unknown Object (File)
Nov 9 2023, 3:38 AM
Unknown Object (File)
Nov 8 2023, 11:36 AM
Unknown Object (File)
Nov 7 2023, 11:36 PM

Details

Summary

I upgraded the FreeBSD features page. I thought it would be better to have a global features instead separated by releases.
In this way the page will not look stale with each release.
I copied some information from the FreeBSD handbook.
Do you think we need to add more information to the features page?

Rendered: https://www.carlavilla.es/features.html

PR: 253706

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
website/content/en/features.adoc
56

I'd use "over 50K" as portmgr endorses that.

65

s/virtualizing/further restricting/

71

s/third party/third-party/

77

s/imported to/imported into/

Clarify "legacy-free".

78

Do you mean grub-bhyve is no longer needed for these use cases?

78

Isn't bhyve x86-specific?

86

s/on top of/on top of a/

I'd also remove "Technically" and perhaps say "It works the same way..."

104

I don't know what "independent instances of networking state" means, but vimage(9) suggests (in DESCRIPTION) that they're virtualized network stacks. If that's correct, I'd use that name instead.

This revision now requires changes to proceed.Jul 15 2022, 8:36 PM
website/content/en/features.adoc
56

I think that number is wrong.

$ find . -name Makefile | wc -l

30533

We have 30533 Makefiles in the ports collection (give or take in case I have some work/ directories around...). It is hard to believe then, that we have over 50K ports.

website/content/en/features.adoc
78

Do you mean grub-bhyve is no longer needed for these use cases?

Correct.

78

Isn't bhyve x86-specific?

Yes it's currently x86 specific (I think there were effort on porting it to aarch64 some time ago, but that haven't been merged to main yet)

website/content/en/features.adoc
11

delete

11

a

16

FreeBSD is less than thirty years old (its 30th anniversary will be in 2023).

38

lowercase b for boot, here and elsewhere

39

reiteration

39

Bootable clones of datasets.

A boot environment allows the system to be upgraded, while preserving the old system environment.

(Reference: https://www.freebsd.org/cgi/man.cgi?query=bectl&sektion=8&manpath=FreeBSD#DESCRIPTION.)

41

reiteration

43

delete

44

Not a real word. Instead:

  • fallback; or
  • (without the preceding word safe) failsafe
44

delete

45

a new (inactive) environment without altering the active environment

47

reiteration

66

Finer

71

delete

71

software titles

(Not all titles are applications.)

71

delete (reiteration)

72

delete

72

delete

72

delete

72

delete

72

ports

website/content/en/features.adoc
56
[pauamma@gadfly] ~% find /usr/ports -maxdepth 2 -depth 2 -type d -print | wc -l
   30283

So yeah, 50K looks increasingly dubious.

78

Yes it's currently x86 specific (I think there were effort on porting it to aarch64 some time ago, but that haven't been merged to main yet)

I would qualify "all supported versions of FreeBSD" then.

website/content/en/features.adoc
44

"fallback" was probably meant here.

website/content/en/features.adoc
22

Yes I would lave this as listed, maybe not that its "Enabled by default" by the general description.
Thank you!

website/content/en/features.adoc
56

We agree on what constitutes a port. If a port has 10 flavors, it's still just one port.

When this was asked on the mailing lists in November 2022 I did some research to find out why nothing was correct.

Thanks, I'm gonna review all the changes and upload again the diff
Btw, there's more text in your corrections than in my changes hahahaha

carlavilla marked 41 inline comments as done.

Fixed almost all the problems and add again capsicum

carlavilla added inline comments.
website/content/en/features.adoc
16

hehehe, yes, but since we're so nearly 2023 I thought we can keep it :$

27

Sorry what list?
This line "Combining the traditionally separate roles of volume manager and file system provides ZFS with unique advantages."?
I read the information about OpenZFS in the wikipedia and in ther official page and both use the same words "volume manager" and "file system"

39

I don't get the change sorry. Can you please copy and paste the correction here?

71

ufff, I personally prefer applications.

77

Free of deprecated code

104

Finally I took all the description used in vimage(9) hehehe :$

Can I go ahead with these changes and improve the document later? Having a features page pointing to FreeBSD 9 and 10 is not a good idea for the project

Can I go ahead with these changes …

Sorry, I can't visualise from what's in Phabricator.

Can you update https://www.carlavilla.es/features.html? For me to see how the current revision appears. Thanks.

Sorry, I upgraded it carlavilla.es/features.html

website/content/en/features.adoc
27

Sorry what list?
This line "Combining the traditionally separate roles of volume manager and file system provides ZFS with unique advantages."?

Yes.

I read the information about OpenZFS in the wikipedia and in ther official page and both use the same words "volume manager" and "file system"

ZFS also has a software RAID component, and I think it deserves a mention./

77

Free of deprecated code

Then I'd use that wording instead.

website/content/en/features.adoc
6–8

Less verbose (and navigation to the page is AboutFeatures).

13
15–17
16
17

FreeBSD is an operating system. It's not found in an operating system.

18–19

This does not add value here; it's not a feature.

It's more the type of thing that might be found somewhere under the Community menu.

19–23
28

Mental note, for a future review: are these three truly still the goals? Elsewhere, I see a different trio.

34
38
40
41–50

Consistency: punctuate the final point only.

54

Less verbose.

If it's necessary to state that things are not stagnant (words to that effect), make a general statement nearer the head of the page. For what it's worth, I think that ongoing development is implicit within the decades blurb.

56–58
58
60–64
61
63
64
69–70
75–76
80–83
80–83
81–82
83

It's comparable, not quite the same.

88–89
89
91–94
93
106
111
112

For a Features page, better refer to something other than a manual page, however there's no mention of VNET in the FreeBSD Handbook; https://wiki.freebsd.org/NetworkVirtualization is historical; and so on.

114

For a reader who is new to this word: there's no mention in the FreeBSD Handbook, https://wiki.freebsd.org/VIMAGE is outdated, and so on.

It's mentioned in the manual page for vnet(9), so maybe present it as VIMAGE.

website/content/en/features.adoc
41–50

I forgot to abbreviate FreeBSD jail to jail

58

Afterthought: this suggested edit is probably wrong.

(Sorry, I find it difficult to interpret AsciiDoc, also some difficulty with Phabricator, I should have swapped out to rendered https://www.carlavilla.es/features.html then back.)

69–70

I can't find it at the moment, but I'm fairly certain that the existing phrase applications and libraries arose in or around another recent review.

I'm gonna try to fix all of your comments and go ahead with the commit.
Right now in the state of this review. I can't follow all your comments. It's impossible to me.
There's more information in your comments than the original information I wrote.
If you think we can improve this even more please open a PR.

This revision was not accepted when it landed; it landed in state Needs Review.Jul 23 2022, 8:52 AM
This revision was automatically updated to reflect the committed changes.

Thanks, everyone –

… can't follow all your comments. …

I reached the same point!

Any major review can be a chore (and there's much to the feature set), but it's well worth it. Future reviews should be much easier …