Page MenuHomeFreeBSD

stable/13: README.md MFCs; README removal
ClosedPublic

Authored by mhorne on Nov 10 2022, 3:57 PM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 24 2024, 10:59 PM
Unknown Object (File)
Jan 26 2024, 10:30 PM
Unknown Object (File)
Jan 16 2024, 9:59 PM
Unknown Object (File)
Dec 20 2023, 8:06 AM
Unknown Object (File)
Dec 13 2023, 3:35 AM
Unknown Object (File)
Dec 12 2023, 7:58 AM
Unknown Object (File)
Nov 15 2023, 9:10 AM
Unknown Object (File)
Nov 6 2023, 7:12 AM

Details

Summary

Catch stable/13 up to changes in main. The continued existence of both README and README.md can be confusing.

Reported by: pauamma

This includes the following commits:

readme: update style

Update the style to one sentence per line, as is currently used in the FreeBSD
document project. Make the links to the handbook clickable.

(cherry picked from commit 2918e9fdb82ffe5e95cab90a754bc6c2b6dd16a2)
Fix arch rendering

(cherry picked from commit dbd92cc2a4915a2070c93cff423314f43edfc841)
readme: Link to COPYRIGHT file

(cherry picked from commit e75eac2cb81c510389f527da14cec4a16123e673)
Update doc links in README

(cherry picked from commit cada2b74b8d670741643dca8e3d40c39d8fc7105)
Whitespace cleanup

(cherry picked from commit aaf998056ed46c0dfb429e3e5cfe624c8aa4dec8)
Remove README in favor of README.md

Complete the transition to README.md I started 3 years ago. Remove the
now-redundant README file. It's currently just README.md w/o the light markup
and adds no real value. This also allows us to use additional MarkDown
markup as we see fit w/o worrying about keeping things in sync.

(cherry picked from commit 8a157722e947191a63e9108cbfb60ee2605858b4)

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 48254
Build 45140: arc lint + arc unit

Event Timeline

lwhsu added a subscriber: lwhsu.

I don't think this MFC really needs approval from core, as it's syncing from the main branch.

jhb added a subscriber: jhb.

That said, fire away.

This revision is now accepted and ready to land.Nov 11 2022, 1:02 AM

I don't think this MFC really needs approval from core, as it's syncing from the main branch.

Indeed, it was a regex match on "GNU General Public License" that added Core as a reviewer.

I don't think this MFC really needs approval from core, as it's syncing from the main branch.

Indeed, it was a regex match on "GNU General Public License" that added Core as a reviewer.

If it were me, I wouldn't have waited :)

core@ already approved it going into head, so separate approval isn't needed unless there's some
material difference. If in the unlikely event it's wrong, core@ can back it out. :)