Page MenuHomeFreeBSD
Differential D41644

FAQ renew - Working Group
ClosedPublic
Actions

Authored by carlavilla on Aug 30 2023, 8:44 AM.
Tags
None
Referenced Files
F103085896: D41644.id127621.diff
Wed, Nov 20, 6:36 PM
Unknown Object (File)
Mon, Nov 18, 3:17 PM
Unknown Object (File)
Thu, Nov 14, 1:02 PM
Unknown Object (File)
Fri, Nov 8, 5:15 AM
Unknown Object (File)
Thu, Nov 7, 10:38 AM
Unknown Object (File)
Wed, Nov 6, 7:45 PM
Unknown Object (File)
Tue, Nov 5, 7:00 AM
Unknown Object (File)
Sun, Nov 3, 12:12 PM
View All Files
Subscribers
ashish
cc
grahamperrin
jhb
zlei

Details

Reviewers
bcr
fernape
lwhsu
arrowd
jrm
• karels
dbaio
emaste
mhorne
Group Reviewers
Doc Committers
doceng
Commits
R9:5ab16dfdedb0: FAQ: Complete FAQ rewrite
Summary

The idea of the FAQ Working group was to simplify the FreeBSD FAQ, reorder some sections and eliminate others.

Here I have added the list of headings, if no one is against or thinks that something is missing to be added, in 2 weeks we will begin to fill in the different sections.

The idea is to try not to reference any version of FreeBSD and try to make the questions and answers global.

The idea is also to keep the FAQ as clean and clear as possible.
For specific things or how to perform a certain task we already have the Handbook and the different articles.

To read more easily: https://people.freebsd.org/~carlavilla/handbook-wg/faq.html

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

carlavilla requested review of this revision.Aug 30 2023, 8:44 AM
carlavilla created this revision.
carlavilla retitled this revision from FAQ WG to FAQ renew - Working Group.
carlavilla updated this revision to Diff 126686.Aug 30 2023, 5:51 PM

Add some entries proposed by fernape@

fernape added a comment.Aug 31 2023, 2:17 PM

LGTM.

I added one more item. If it overlaps with the answer to another FAQ, we can remove it.

carlavilla updated this revision to Diff 127109.Sep 8 2023, 9:37 AM

Add introduction section

carlavilla edited the summary of this revision. (Show Details)Sep 8 2023, 9:38 AM
emaste added inline comments.Sep 20 2023, 1:18 PM
documentation/content/en/books/faq/_index.adoc
35

are these really supposed to be unicode ellipses? …

560–561

add "elected" to Core Team

560–561

I'd say "many" instead of "most."

561–563

I would just drop these explicit references, just mention what FreeBSD's goals are.

carlavilla updated this revision to Diff 127599.Sep 21 2023, 2:24 PM
carlavilla marked 4 inline comments as done.

Fix comments from @emaste

fernape added inline comments.Sep 21 2023, 3:38 PM
documentation/content/en/books/faq/_index.adoc
560–561

Since this does not pretend to be an exhaustive list, I would use a disjunctive:

...such as the overall direction of the project and who is allowed... --> ...such as the overall direction of the project or who is allowed...

560–561

I'm not sure if this should be Feel free to modify, distribute...

560–561

Although it was in the original too, shouldn't the comma be *after* though?

...comes with slightly more strings attached, though at least on the side of enforced access rather than the usual opposite. --> ...comes with slightly more strings attached though, at least on the side of enforced access rather than the usual opposite.

561

...between FreeBSD and NetBSD, OpenBSD, and other... --> ...between FreeBSD, NetBSD, OpenBSD, and other...

561

To avoid repeating snapshot how about?

These snapshots represent a snapshot in time... --> These snapshots capture a moment in time...

561

I had the idea that there is a hard coded limit in the code... FreeBSD can support more, but then the limit needs to be changed and the kernel recompiled.

561

This paragraph title does not render properly, but that is most likely due to the empty body in the previous one.

562

I would remove this sentence.
It does not belong to this section, but to the next one where there is already a very similar sentence.

562

Link to books/handbook/ports?

carlavilla updated this revision to Diff 127621.Sep 22 2023, 6:50 AM
fernape added a comment.Sep 22 2023, 7:26 AM

Trying to fix the offset of the comments after the update in the review.

documentation/content/en/books/faq/_index.adoc
560–561

Since this does not pretend to be an exhaustive list, I would use a disjunctive:

...such as the overall direction of the project and who is allowed... --> ...such as the overall direction of the project or who is allowed...

560–561

I'm not sure if this should be Feel free to modify, distribute... or The license means you are free to modify...

560–561

Although it was in the original too, shouldn't the comma be after though?

...comes with slightly more strings attached, though at least on the side of enforced access rather than the usual opposite. --> ...comes with slightly more strings attached though, at least on the side of enforced access rather than the usual opposite.

561

...between FreeBSD and NetBSD, OpenBSD, and other... --> ...between FreeBSD, NetBSD, OpenBSD, and other...

562

I would remove this sentence.
It does not belong to this section, but to the next one where there is already a very similar sentence.

562

Link to books/handbook/ports?

carlavilla marked 14 inline comments as done.Sep 23 2023, 6:48 PM
carlavilla added a subscriber: jhb.
carlavilla added inline comments.
documentation/content/en/books/faq/_index.adoc
561

Yes, that is why, in the final version we will not have that problem :)

561

I will ask @emaste or @jhb to see if they can help us with this question, I leave the comment unmarked.

562

Personally I prefer to keep the links between documents to a minimum, but if you think it is essential to add links here, I can add the links without problems

carlavilla updated this revision to Diff 127684.Sep 23 2023, 6:53 PM
carlavilla marked 2 inline comments as done.

Fix Fernando's comments

carlavilla updated this revision to Diff 127686.Sep 23 2023, 8:26 PM

Add more sections

fernape added inline comments.Sep 24 2023, 4:49 PM
documentation/content/en/books/faq/_index.adoc
560–561

Since we link to the Architecture Handbook, I would link to the Handbook too.

561

Ummm. It doesn't render properly in the preview.

fernape added inline comments.Sep 24 2023, 6:08 PM
documentation/content/en/books/faq/_index.adoc
560–561

Found it:

$ find . -name param.h -exec egrep -H '.*define.*MAXCPU.*' {} \;
./sys/amd64/include/param.h:#define MAXCPU              1024
./sys/amd64/include/param.h:#define MAXCPU              1
./sys/arm/include/param.h:#define       MAXCPU          4
./sys/arm/include/param.h:#define       MAXCPU          1
./sys/arm64/include/param.h:#define     MAXCPU          1024
./sys/arm64/include/param.h:#define     MAXCPU          1
./sys/i386/include/param.h:#define MAXCPU               32
./sys/i386/include/param.h:#define MAXCPU               1
./sys/powerpc/include/param.h:#define   MAXCPU          256
./sys/powerpc/include/param.h:#define   MAXCPU          1
./sys/riscv/include/param.h:#define     MAXCPU          16
./sys/riscv/include/param.h:#define     MAXCPU          1

Those are the maximum number of CPUs per architecture.

carlavilla updated this revision to Diff 127720.Sep 24 2023, 6:45 PM

Finish the FAQ and fix some comments :)

carlavilla marked 4 inline comments as done.Sep 24 2023, 6:46 PM
carlavilla added inline comments.
documentation/content/en/books/faq/_index.adoc
560–561

Niceeeeeeeeeeeeeeeeeeeeeeee, thank you for that!!!

carlavilla marked an inline comment as done.Sep 24 2023, 6:48 PM

Still need to check the render issue, working on that

carlavilla updated this revision to Diff 127721.Sep 24 2023, 6:59 PM

Fix render issue

fernape added inline comments.Sep 25 2023, 9:55 AM
documentation/content/en/books/faq/_index.adoc
414

While this was in the original document, I think the memory consumption of shells is of no relevance these days.

carlavilla marked an inline comment as done.Sep 27 2023, 5:46 PM
carlavilla added inline comments.
documentation/content/en/books/faq/_index.adoc
414

Done :)

carlavilla updated this revision to Diff 127876.Sep 27 2023, 5:47 PM
carlavilla marked an inline comment as done.

Fix Fernando's comment

fernape accepted this revision.Sep 28 2023, 8:48 AM

Macro lgtm:

This revision is now accepted and ready to land.Sep 28 2023, 8:48 AM
cc added a subscriber: cc.Sep 28 2023, 8:38 PM

Click the the section of "5. Community Questions" from the "Table of Contents" (in your web page link below) does not jump to that section. Other links from the "Table of Contents" work. Please consider if this requires update.

https://people.freebsd.org/~carlavilla/handbook-wg/faq.html

ashish added a subscriber: ashish.Sep 29 2023, 8:26 AM
ashish added inline comments.
documentation/content/en/books/faq/_index.adoc
221

Is it really recommended for production systems ? This[0] offers opposite advice.

References:
[0] https://docs.freebsd.org/en/books/handbook/cutting-edge/#stable

zlei added a subscriber: zlei.Oct 2 2023, 2:51 PM
carlavilla marked an inline comment as done.Oct 7 2023, 7:51 AM
carlavilla added inline comments.
documentation/content/en/books/faq/_index.adoc
221

Good catch :)

carlavilla updated this revision to Diff 128390.Oct 7 2023, 7:51 AM
carlavilla marked an inline comment as done.

Fix comments.

This revision now requires review to proceed.Oct 7 2023, 7:51 AM
This revision was not accepted when it landed; it landed in state Needs Review.Oct 11 2023, 7:23 PM
Closed by commit R9:5ab16dfdedb0: FAQ: Complete FAQ rewrite (authored by carlavilla). · Explain Why
This revision was automatically updated to reflect the committed changes.
carlavilla added a commit: R9:5ab16dfdedb0: FAQ: Complete FAQ rewrite.
grahamperrin added a subscriber: grahamperrin.Oct 12 2023, 11:01 AM

I recall accepting the invitation to participate in this working group.

Revision Contents
Changeset List

PathSize
documentation/
content/
en/
books/
faq/
3289 lines

Diff 128390

View Options

documentation/content/en/books/faq/_index.adoc

Loading...