Page MenuHomeFreeBSD

[articles][committers-guide]: streamlining stable/N and releng/N.n syntax
Needs ReviewPublic

Authored by freebsd_ny-central.org on Nov 9 2024, 11:12 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Dec 15, 5:59 PM
Unknown Object (File)
Tue, Dec 10, 11:23 AM
Unknown Object (File)
Wed, Dec 4, 4:53 AM
Unknown Object (File)
Wed, Dec 4, 4:30 AM
Unknown Object (File)
Thu, Nov 21, 5:44 PM
Unknown Object (File)
Nov 17 2024, 3:19 PM
Unknown Object (File)
Nov 17 2024, 8:10 AM
Unknown Object (File)
Nov 15 2024, 1:32 AM
Subscribers
None

Details

Summary

As outlined in https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=279503 there are
various ways we are listing stable/N and releng/N.n - sometimes with numbers,
sometimes not.

I'm suggesting to migrate everything into one common format. What I have not
resolved yet (and would appreciate feedback on): there are still numerous
examples with i.e. stable/13 (I updated from stable/12). It would make sense to
simply change them all into a stable/N and releng/N.n format.

Ed made the point that he received issue reports for people misunderstanding the
placeholder syntax, so maybe it makes sense to leave a handful of examples with
numbers?

PR: 279503

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
No Lint Coverage
Unit
No Test Coverage
Build Status
Buildable 60480
Build 57364: arc lint + arc unit

Event Timeline

This revision is now accepted and ready to land.Nov 9 2024, 3:28 PM

Looks good to me. Thank you.

This seems to do well to address @emaste's concern (in bug 279503) about generic names by including concrete examples such as

(where N is the major release number, i.e. up to 14 as of 2024)

Let's give it a few days to see if anyone else has comments. If not, I'll commit.

documentation/content/en/articles/committers-guide/_index.adoc
463–464
897–899

These form part of the same example, so it doesn't make sense to have ...stable-14 in the first line and stable/13 in the second.

943–945

We should definitely be consistent, but I'm not sure if N.n or X.Y is the preferable form.

  • version numbers and 1st person statements fixed
  • switched to X.Y because it's used in other places of the docs
  • replaced the first person "I" statements except for the Q&A
This revision now requires review to proceed.Nov 9 2024, 8:24 PM

Additional improvements after receiving feedback on FreeBSD Forums

  • replaced abbreviations
  • fixed a typo/number with its variable representation
  • simplified listing of branch names

Reviewed by: Erichans

Replacing version numbers with variables (where possible), fixing vars.

  • replacing 14 with betarel-current-major
  • replacing 14.2 with betarel-current
  • fixing dev-src-all et al mailing list variables