src layout
ClosedPublic
Actions

Authored by mhorne on Oct 26 2022, 4:03 PM.

Details

Reviewers

emaste
imp

Commits

rG1be2773e631a: hier(7): remove text describing /usr/src layout
rG552e24e4549a: hier(7): remove text describing /usr/src layout
rGf0e4e021103c: hier(7): remove text describing /usr/src layout

Summary

It poses a maintenance burden, since much of the information is
duplicated in the src tree's README.md file. Readers who are interested
enough in learning about the structure of the src tree can download it,
or browse the README online. Have hier(7) just point them there instead.

PR: 261349

Test Plan

Request feedback from freebsd-arch@, freebsd-doc@ lists.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 48008
Build 44895: arc lint + arc unit

Event Timeline

mhorne created this revision.Oct 26 2022, 4:03 PM

Herald added a subscriber: imp. · View Herald TranscriptOct 26 2022, 4:03 PM

mhorne requested review of this revision.Oct 26 2022, 4:03 PM

Harbormaster completed remote builds in B48008: Diff 112214.Oct 26 2022, 4:03 PM

mhorne added a parent revision: D37134: README.md: shift description of kernel config files.Oct 26 2022, 4:03 PM

mhorne added a child revision: D37136: development(7): redirect users from hier(7).

mhorne edited the test plan for this revision. (Show Details)Oct 26 2022, 4:09 PM

mhorne added a subscriber: grahamperrin.

This makes sense to me, there is no point in duplicating this information.

This revision is now accepted and ready to land.Oct 26 2022, 5:55 PM

Not 100% sure that README.md is the right final place for it, but it's there now and having it one place rather than two is better and we can move it later, should we need too... I'm also not sure that there's a better place, so that suggests going ahead with this is best.

Found a typo. You can fix it when committing. Thanks for this work!