Bug 209744 - Move installation instructions from UPDATING to new file
Summary: Move installation instructions from UPDATING to new file
Status: New
Alias: None
Product: Base System
Classification: Unclassified
Component: misc (show other bugs)
Version: CURRENT
Hardware: Any Any
: --- Affects Only Me
Assignee: FreeBSD Release Engineering
Depends on:
Reported: 2016-05-25 02:38 UTC by Adam Weinberger
Modified: 2021-11-20 06:33 UTC (History)
2 users (show)

See Also:


Note You need to log in before you can comment on or make changes to this bug.
Description Adam Weinberger freebsd_committer 2016-05-25 02:38:09 UTC
Currently, the instructions for how to build/upgrade/install FreeBSD start at line 1,371, and that number keeps getting higher.

Surely that information is more important than the notes from 5 years ago that sit above it.

I would like to propose pulling the "COMMON ITEMS" stuff into a new file. GNU has got people trained to look for that sort of thing in a file called INSTALL, so that's where I'd propose putting it: /usr/src/INSTALL.
Comment 1 Glen Barber freebsd_committer 2016-05-25 02:42:07 UTC
Adding Warner to the CC list.  Similar topic came up a while back, and he specifically requested to be a part of any changes in this regard.
Comment 2 Adam Weinberger freebsd_committer 2016-05-25 02:48:09 UTC
(In reply to Glen Barber from comment #1)
I'm the one who brought it up before :-)

I had an issue recently where I needed the ZFS boot block command, and had to page through over 80 screens over a bad VNC connection to get to the good stuff on 10-RELEASE.
Comment 3 Glen Barber freebsd_committer 2016-05-25 02:51:02 UTC
Oh, oops.  :-)

"Thank you for the reminder," instead? :-)
Comment 4 Warner Losh freebsd_committer 2016-05-25 03:53:19 UTC
I'd prefer we prune things for each major release, which we haven't done in far too long.

I'm not sure that moving it now would be a good idea. Let's see what pruning it back results in. Or maybe adding a 'search for XXX' to the top...
Comment 5 Adam Weinberger freebsd_committer 2018-03-02 20:19:29 UTC
The installation instructions are now at line 1,868 in head, and 1,498 in 11.1-RELEASE. 

Is there still interest in this? I still think putting those "COMMON ITEMS" in /usr/src/INSTALL would make the information immediately accessible, and obviates the need to prune UPDATING.

There's some really crucial information in that COMMON ITEMS section.
Comment 6 Graham Perrin 2021-11-20 06:33:59 UTC
(In reply to Adam Weinberger from comment #5)

> … Is there still interest in this? …

I think so. I recall some discussion about pruning (or words to that effect) a few months ago. 

Bug 252417 comment 8 falls somewhere between (a) the status quo and (b) a move to a separate file. My suggestion there is, essentially, to have a near-head hint of a signficant change that's near the foot of the page.