-
Notifications
You must be signed in to change notification settings - Fork 24
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
faq.php: some definitions: begin improvements #610
base: main
Are you sure you want to change the base?
Conversation
A tentative, fairly major rewrite of much of this section.
Draft. Some of this might be contentious. For what it's worth, I think that we need to reshape and reframe existing text before attempting to weave in: Postscript (notes to self):
|
Oops, I forgot to reinsert the part that was originally:
It's an important point, however:
I lean towards mentioning pkg(8), however:
In my mind, lazy nearly always includes:
|
Accept Dan's suggestion, FreshPorts#610 (review)
|
||
If you install a port, the source will be downloaded, patched if | ||
necessary, compiled and installed. If the port has any default | ||
configuration option that is preset by the maintainer, you can choose |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Some ports have default configuration options. During the build process, you can set these various options."
There's a mix of plural and singular.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I was also not particularly happy with the mixture. I'm vaguely trying to convey:
- some ports have no more than one option
- wherever there's an option, there's the maintainer-set default (true?)
– as succinctly as possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminding myself (an example):
- https://www.freshports.org/editors/ghostwriter/#config config anchor for Configuration options
- https://www.freshports.org/editors/ghostwriter/#options options anchor for Options name.
Options … configuration options … build options … compile-time options …
On one hand, I quite like the phrase build options.
On the other hand, let's compare with something on the poudriere side.
poudriere options – configure the options for a given port
|
||
<h2>Definitions for the hopelessly lazy</h2> | ||
|
||
<h3 id="port">What is a port?</h3> | ||
<p> | ||
If you install the port, the source will be downloaded, patched if necessary, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section contains a highly simplified overview of ports and packages. We have glossed over many details. More experienced users may feel compelled to point out misleading or incorrect points. Instead, they should submit patches whilst keeping the first sentence in mind.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy with a fair amount of glossing-over, because:
- Definitions for the hopelessly lazy is a light-hearted heading
- we plead with the reader to be familiar with the ports-related chapter of the FreeBSD Handbook
- the Foundation's blog post concludes with a link to the same chapter
- the last part of the chapter has "Fix it!" as point 3 of 4.
Resolve Dan's FreshPorts#610 (review)
Accept Dan's suggestion, FreshPorts#610 (comment)
A tentative, fairly major rewrite of much of this section.