Bug 273483

Summary: Fix the link from the debugging section of the Porter's Handbook, to the Developers' Handbook
Product: Documentation Reporter: Graham Perrin <grahamperrin>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Some People CC: doc, mhorne
Priority: --- Keywords: easy
Version: Latest   
Hardware: Any   
OS: Any   
URL: https://codeberg.org/grahamperrin/freebsd-doc/pulls/12
See Also: https://reviews.freebsd.org/D41653
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=247271
Attachments:
Description Flags
signed-off .patch
grahamperrin: maintainer-approval? (doc)
Screenshot of the fix for 989d921f5d
none
Screenshot of the fix for 5ff4e8af63 none

Description Graham Perrin 2023-08-31 16:32:37 UTC 
5ff4e8af631f [phb]: Add information on how to debug ports

<https://docs.freebsd.org/en/books/porters-handbook/book/#testing-debugging-ports> the last sentence in the section refers to: 

<https://docs.freebsd.org/en/books/developers-handbook/#debugging>

This results in the front page of the book, not to the debugging information therein.
Comment 1 Graham Perrin 2023-09-01 06:34:35 UTC 
Work in progress.
Comment 2 Graham Perrin 2023-09-01 06:41:32 UTC 
Created attachment 244542 [details]
signed-off .patch

Fix a {freebsd-ports} link.

Fix the recently introduced link to a debugging subsection of the FreeBSD
Developers' Handbook. Apply the link to relevant words.

Be concise: no need to repeat the word 'debugging'.

Markup: one sentence per line.

Fixes: 989d921f5d Migrate doc to Hugo/AsciiDoctor
Fixes: 5ff4e8af63 [phb]: Add information on how to debug ports
Comment 3 Graham Perrin 2023-09-01 06:42:50 UTC 
Created attachment 244543 [details]
Screenshot of the fix for 989d921f5d
Comment 4 Graham Perrin 2023-09-01 06:43:32 UTC 
Created attachment 244544 [details]
Screenshot of the fix for 5ff4e8af63
Comment 5 commit-hook freebsd_committer freebsd_triage 2023-10-20 18:23:46 UTC 
A commit in branch main references this bug:

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

commit a88c229418799e2273c6c37a4014dd6c3bac4136
Author:     Mitchell Horne <mhorne@FreeBSD.org>
AuthorDate: 2023-10-20 18:14:55 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2023-10-20 18:22:48 +0000

    porters-handbook: fix external link

    The link to the Debugging section of the Developer's Handbook is
    incorrect. Adjust it.

    PR:             273483
    Reported by:    Graham Perrin <grahamperrin@gmail.com>
    Sponsored by:   The FreeBSD Foundation

 documentation/content/en/books/porters-handbook/testing/_index.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 6 Graham Perrin 2023-10-20 22:12:28 UTC 
(In reply to commit-hook from comment #5)

Mitchell, thanks! 

(In reply to Graham Perrin from comment #2)

Closed: pull request <https://codeberg.org/grahamperrin/freebsd-doc/pulls/12>, from which the .patch file was taken. I can make a separate PR for grammatical <https://codeberg.org/grahamperrin/freebsd-doc/commit/0c2d9a420ed3bc064814c67096d64e2d2e40376b> (the third of three within PR 12).
Comment 7 Mitchell Horne freebsd_committer freebsd_triage 2023-10-23 16:51:45 UTC 
(In reply to Graham Perrin from comment #6)

Sure, I can confirm that grammar fix. I am not set up to handle anything via codeberg.