Page MenuHomeFreeBSD

Various updates to the 13.0 release notes.
ClosedPublic

Authored by jhb on Mar 13 2021, 1:54 AM.

Details

Summary
  • Remove extraneous quotes from attributes.
  • Prefer passive voice to active voice when describing changes.
  • Correct a few entries that claimed functionality changed when the associated changes were changes to the documentation.
  • Move the VirtIO V1 comment to the device drivers section and make it more generic as well as adding missing context for Q35 (it's specific to QEMU).
  • Trim the bhyve entries to not include changes already present in 12.2. Also, don't list bugfixes to previous changes, e.g. a single entry for VM snapshots is sufficient from a user's perspective.
  • Replace some bhyve entries with broader entries such as support for LA57 and Hygon Dhyana.
  • In the note about the i386 CPUTYPE, shift to present tense instead of future tense.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

jhb requested review of this revision.Mar 13 2021, 1:54 AM
jhb created this revision.

After this I plan to go through RELNOTES on 13 pulling over entries that aren't yet present as the next change. I'm not sure if I'll have time to try to trawl 'git log' looking for 'Relnotes:yes' changes afterwards, but in theory that could also stand doing.

website/content/en/releases/13.0R/relnotes.adoc
98

This is just a sample entry, but thank you for fixing the wording.

This revision is now accepted and ready to land.Mar 13 2021, 2:06 AM
In D29244#654726, @jhb wrote:

After this I plan to go through RELNOTES on 13 pulling over entries that aren't yet present as the next change. I'm not sure if I'll have time to try to trawl 'git log' looking for 'Relnotes:yes' changes afterwards, but in theory that could also stand doing.

The mind-numbing task of going through two years of commits is my primary focus next week. Note, I have sent two solicitations to the developers list for help on making sure the 13.0 release notes do not suck, with minimal feedback.

Lack of help, in addition to my infamiliarity with asciidoc/hugo, ... well, I am only one person.

In D29244#654741, @gjb wrote:

Lack of help, in addition to my infamiliarity with asciidoc/hugo, ... well, I am only one person.

If you need help with adoc or hugo, don't hesitate to reach out.

I also have a few more things I've been working on that I need to push, but they need a final pass first.

Except for one minor nit as noted, this looks good to me.

website/content/en/releases/13.0R/relnotes.adoc
243

I'm not sure the ping6 utility has been removed.
It still works for me on 14-CURRENT, and src/sbin/ping/ping6.c was added in the noted commit.

This would also be a violation of POLA, which I don't believe was the intent of the commit.

  • Rebase and update some new entries.
  • Review feedback.
This revision now requires review to proceed.Mar 15 2021, 6:54 PM
jhb marked an inline comment as done.Mar 15 2021, 6:54 PM
jhb added inline comments.
website/content/en/releases/13.0R/relnotes.adoc
243

Hmm, we might have kept a hardlink. I will reword this though to say they were merged.

website/content/en/releases/13.0R/relnotes.adoc
112

To be pedantic we might want to say C99/C++ style :)

121–122

maybe even shorter just
the -H flag to close and re-open the output file when SIGHUP is received.

138

we have some entries with "the foo now does bar" and some "the foo does bar", which form do we want to use?

e.g. "consistently prints dates" above

267

reports

319

how about

for the i386 architecture is 686 (instead of 486)

321–323

We should probably expand what "this functionality" means? Something like

Users who need to run on 486- or 586-class CPUs will need to build their own releases.

328–332

TBH I'd drop most of this justification.

jhb marked 4 inline comments as done.Mar 15 2021, 11:26 PM
jhb added inline comments.
website/content/en/releases/13.0R/relnotes.adoc
112

I was just fixing the passive/active voice here. :)

138

Hmmm. I have mostly stuck with "now" in my later changes, but honestly I probably don't like "now" and think it is kind of redundant. It is implied that these things are all "new" and it would be simpler to not have to say "now" everywhere I think. OTOH. some of the entries may be kind of odd without the now (e.g. the VirtIO V1 note I added below)

180–184

Ugh, I missed this one when I rebased.

267

The subject is "drivers" so "report" is correct.

328–332

I probably would too, but it just got expanded over the weekend, so I'll punt on trimming this further.

website/content/en/releases/13.0R/relnotes.adoc
267

Indeed it is, somehow I read "driver now report"

This revision was not accepted when it landed; it landed in state Needs Review.Mar 15 2021, 11:57 PM
This revision was automatically updated to reflect the committed changes.