Bug 269540

Summary: `make run` is invalid in top level of doc
Product: Documentation Reporter: Andrey Portnoy <aportnoy>
Component: Books & ArticlesAssignee: Sergio Carlavilla Delgado <carlavilla>
Status: Closed FIXED    
Severity: Affects Many People CC: carlavilla, gbe
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
Fix suggested by Ceri Davies. none

Description Andrey Portnoy 2023-02-13 23:21:28 UTC
Created attachment 240140 [details]
Fix suggested by Ceri Davies.
Comment 1 Andrey Portnoy 2023-02-14 15:18:13 UTC
Context: documentation primer section 1.2.2 (https://docs.freebsd.org/en/books/fdp-primer/overview/#gnu-linux-installation-process) suggests running `bmake` from top of tree to build the docs, followed by `bmake run`.

What it doesn't point out is you first need to change directory to say documentation or website before invoking `bmake run`. The patch adds a warning about this.
Comment 2 commit-hook freebsd_committer freebsd_triage 2023-02-17 15:31:59 UTC
A commit in branch main references this bug:

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

commit 02a9f38f18db8c0465214ac2bc3a1f5337786610
Author:     Andrey Portnoy <aportnoy@fastmail.com>
AuthorDate: 2023-02-17 15:30:44 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-02-17 15:30:44 +0000

    Warn users that 'make run' should be used on subdirectories

    PR:             269540

 Makefile | 3 +++
 1 file changed, 3 insertions(+)
Comment 3 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-02-17 15:32:36 UTC
Fixed. Thanks, I'll upgrade the FDP too