Bug 251279 - [patch] Added wording to the handbook ports chapter about branches as they relate to using portsnap.
Summary: [patch] Added wording to the handbook ports chapter about branches as they re...
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Ceri Davies
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-11-20 21:13 UTC by Fred
Modified: 2021-06-29 20:36 UTC (History)
2 users (show)

See Also:

Attachments
svn diff of en_US.ISO8859-1/handbook/ports/chapter.xml (810 bytes, patch)
2020-11-20 21:13 UTC, Fred 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Fred 2020-11-20 21:13:20 UTC 
Created attachment 219841 [details]
svn diff of en_US.ISO8859-1/handbook/ports/chapter.xml

I added some wording, to the ports chapter of the handbook, where it explains the use of portsnap(Procedure 4.1). The new wording explains which branch of the Ports Collection is used by portsnap. I wasn't able to easily find this information so I thought it should be included in the handbook. Please consider the diff and if you think the added explanation is appropriate and accurate please commit it.

This bug report is a follow-up to one I submitted recently which is 251195.
Comment 1 Fred 2020-12-07 20:25:05 UTC 
Just wondering if somebody could take a look at this patch for the handbook in regard to portsnap. 

Thanks.
Comment 2 Mateusz Piotrowski freebsd_committer freebsd_triage 2020-12-13 22:39:08 UTC 
Thanks for the submission! We'll definitely take a look at it, but I personally just don't have time at the moment to properly review the patch.
Comment 3 Benjamin Kaduk freebsd_committer freebsd_triage 2020-12-30 06:39:32 UTC 
Thanks for putting this together.  It was going to need at least some minor editing (to capitalize "Portsnap" and put it in an <application> tag), and I ended up doing some fairly heavy rewording as well while I was there.  Please take a look at https://reviews.freebsd.org/D27843 and see if it covers what you think is needed.
Comment 4 Fred 2021-01-05 18:59:28 UTC 
Benjamin,

I'm not sure who you intended to review the edits/changes you made but they look OK to me. I think it can be committed to the docs repo as you have it.
Comment 5 Ceri Davies freebsd_committer freebsd_triage 2021-06-29 20:35:07 UTC 
yoink after checking with bjk
Comment 6 commit-hook freebsd_committer freebsd_triage 2021-06-29 20:35:30 UTC 
A commit in branch main references this bug:

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

commit 554d62acd0880b3f8f9ad6f10d3f302915e7a37a
Author:     Ceri Davies <ceri@FreeBSD.org>
AuthorDate: 2021-06-29 20:32:05 +0000
Commit:     Ceri Davies <ceri@FreeBSD.org>
CommitDate: 2021-06-29 20:32:05 +0000

    handbook/ports: Note that portsnap only tracks the main branch.

    PR:             251279
    Reported by:    Fred <fjs.usa01@gmail.com>
    Reviewed by:    crees
    Obtained from:  bjk
    Differential Revision:  https://reviews.freebsd.org/D27843

 documentation/content/en/books/handbook/ports/_index.adoc | 7 +++++++
 1 file changed, 7 insertions(+)
Comment 7 Ceri Davies freebsd_committer freebsd_triage 2021-06-29 20:36:07 UTC 
Slightly altered patch committed - thank you for your report!