Page MenuHomeFreeBSD

fix typos in documentation
ClosedPublic

Authored by vladlen on Wed, Jul 1, 7:28 PM.
Tags
Referenced Files
F161713303: D58001.id181193.diff
Mon, Jul 6, 4:34 AM
F161708716: D58001.id181192.diff
Mon, Jul 6, 3:43 AM
Unknown Object (File)
Sat, Jul 4, 2:13 PM
Unknown Object (File)
Fri, Jul 3, 12:12 AM
Subscribers

Details

Reviewers
None
Group Reviewers
doceng
Commits
R9:f37462900694: fix typos in documentation

Diff Detail

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

Event Timeline

vladlen retitled this revision from git commit -m 'fix typos in documentation' to fix typos in documentation.
This revision was not accepted when it landed; it landed in state Needs Review.Wed, Jul 1, 7:31 PM
This revision was automatically updated to reflect the committed changes.

We can't make changes to past release notes once they are published. They become part of the release hash and would change in a number of places that reference them (even if they contain typos).

In D58001#1330236, @bcr wrote:

We can't make changes to past release notes once they are published. They become part of the release hash and would change in a number of places that reference them (even if they contain typos).

I was under the impression that this was only for the announcement and we can fix the release notes themselves.

In D58001#1330236, @bcr wrote:

We can't make changes to past release notes once they are published. They become part of the release hash and would change in a number of places that reference them (even if they contain typos).

There was a recent discussion in releng (I don't recall
if it was on the mailing list or a thread CC'd to re@FreeBSD.org)
about whether we can modify old relnotes.adoc and hardware.adoc
when there's an obvious error. The conclusion was that since neither
of these documents is cryptographically signed now (only announcement),
they can be changed. relnotes contains important information for users
and should not be misleading.

Also, note that the old release notes were mechanically converted
from HTML -> DocBook -> AsciiDoc.

That said, I'm not insisting on this — I'm open to other opinions.
Let's make sure this procedure is done correctly.

P.S. I ran spellcheck on all documents in the website tree,
but I excluded relnotes for 8.0R and earlier (considering
them historical artifacts) as well as signed files like
announcements and security advisories.