Bug 274709 - Documentation: NanoBSD - Explain how to add missing source files
Summary: Documentation: NanoBSD - Explain how to add missing source files
Status: Closed FIXED
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:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-10-25 06:12 UTC by gaelanlloyd
Modified: 2023-11-27 15:31 UTC (History)
3 users (show)

See Also:


Attachments
Git patch with changes (1.21 KB, application/mbox)
2023-10-25 06:12 UTC, gaelanlloyd
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description gaelanlloyd 2023-10-25 06:12:33 UTC
Created attachment 245857 [details]
Git patch with changes

Hello there, here's a suggested documentation change for NanoBSD to help users that have empty /usr/src directories. I got stuck here at the very first step for a while because I didn't install src during my OS install so I couldn't figure out what to do here.

I believe I've linked to the handbook entry properly, but a verification would help. Thanks!
Comment 1 Minsoo Choo 2023-11-24 02:15:00 UTC
https://reviews.freebsd.org/D42743

I added some lines so that readers can learn how to obtain source code without jumping to another page.
Comment 2 gaelanlloyd 2023-11-24 15:14:53 UTC
(In reply to Minsoo Choo from comment #1)

I like that. Can we add in more explanation, such as:

```
The source code of FreeBSD, stored at `/usr/src`, is required to build NanoBSD. If that path doesn't exist or is empty, you can install the source code by:
```

This will address my earlier issue of not knowing what to do if /usr/src is empty or what that folder is for.
Comment 3 commit-hook freebsd_committer freebsd_triage 2023-11-27 15:25:55 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=02d9ae11650e82b2129f80d3e19a826e7c731585

commit 02d9ae11650e82b2129f80d3e19a826e7c731585
Author:     Minsoo Choo <minsoochoo0122@proton.me>
AuthorDate: 2023-11-27 15:04:53 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-11-27 15:05:00 +0000

    NanoBSD: add how to obtain the source code

    There is a request in the bugzilla report to introduce how to obtain the
    source code for building NanoBSD. I added more lines to the patch
    provided by the original reporter.

    PR:             274709
    Reviewed by:    mhorne
    Co-Authored-By: gaelan@fastmail.fm
    Differential Revision: https://reviews.freebsd.org/D42743

 documentation/content/en/articles/nanobsd/_index.adoc | 10 ++++++++++
 1 file changed, 10 insertions(+)