Bug 263494 - beinstall.sh(8) should be in the FreeBSD Handbook
Summary: beinstall.sh(8) should be in the FreeBSD Handbook
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL: https://github.com/freebsd/freebsd-do...
Keywords: needs-patch
Depends on:
Blocks: handbook-2022
  Show dependency treegraph
 
Reported: 2022-04-23 14:45 UTC by Graham Perrin
Modified: 2023-08-22 05:59 UTC (History)
7 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2022-04-23 14:45:02 UTC
Essentially, for a run of the script without options, something like these four steps: 

build world and kernel
pkg bootstrap
cd /usr/src
/usr/src/tools/build/beinstall.sh


Thoughts
========

Use of this FreeBSD-provided script can make a quick start even quicker, so aim to mention it under (or not too far from) <https://docs.freebsd.org/en/books/handbook/cutting-edge/#updating-src-quick-start>.


Source, manual pages and background
===================================

<https://github.com/freebsd/freebsd-src/blob/main/tools/build/beinstall.sh>

beinstall.sh(8) 
<https://www.freebsd.org/cgi/man.cgi?query=beinstall.sh&sektion=8&manpath=FreeBSD>

pkg(7) 
<https://www.freebsd.org/cgi/man.cgi?query=pkg&sektion=7&manpath=FreeBSD> (section 7, not 8; in FreeBSD, not ports). 


<https://forums.freebsd.org/posts/357552> (2017) dch@ wrote: 

>  … if you build from source, there is this amazing gem … 
> Does The Right Thing - creates a boot environment, installs into it, 
> upgrades the packages in the new BE, and finally merges in any changes 
> to /etc for you. …


<https://forums.freebsd.org/posts/393634> (2018): 

> You may want to take a look on beinstall.sh. Currently it is just 
> available on -CURRENT but should work fine on 11.XR …. This basically 
> wrap sysutils/beadm and automatize the process safely. ;) …


building FreeBSD from source into a BE - HackMD
<https://hackmd.io/@dch/r1X8LNVaB> thanks to dch@

> … wrapper around Will Andrews' super-duper beinstall.sh script …
Comment 1 Mateusz Piotrowski freebsd_committer freebsd_triage 2022-07-28 13:56:34 UTC
Sounds like a good idea.
Comment 2 Fernando Apesteguía freebsd_committer freebsd_triage 2022-10-09 16:13:24 UTC
^Triage: reporter is committer, assign accordingly.
Comment 3 Graham Perrin freebsd_committer freebsd_triage 2022-12-30 11:59:44 UTC
Triage, batch edit (just one): 

* for twenty-eight FreeBSD Handbook-related reports that had gained a 
  personal assignee, prior group/list assignee doc@ was 
  missing from the CC list.

Gentle hint: <https://wiki.freebsd.org/Bugzilla/> ▶ do, don't …
Comment 4 Fernando Apesteguía freebsd_committer freebsd_triage 2023-08-21 06:25:48 UTC
^Triage: Reporter is committer, assign accordingly

Any committer may commit to any repository with an accepted review from any committer with existing access to that repository.

Committers may obtain review via a Differential in Phabricator, adding the "Contributor Reviewers ($Repository)" group as a Reviewer, reaching out to other committers; directly or via mailing lists, or setting the attachment flag to: maintainer-approval ? <person-youd-like-to-review>