Bug 264763 - handbooks: Remove references to portsnap
Summary: handbooks: Remove references to portsnap
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Chris Rees
URL:
Keywords: patch
Depends on:
Blocks: handbook-2022
  Show dependency treegraph
 
Reported: 2022-06-19 09:37 UTC by Muhammad Moinur Rahman
Modified: 2023-08-26 10:51 UTC (History)
7 users (show)

See Also:


Attachments
Remove portsnap (15.39 KB, patch)
2022-06-19 09:37 UTC, Muhammad Moinur Rahman
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Muhammad Moinur Rahman freebsd_committer freebsd_triage 2022-06-19 09:37:15 UTC
Created attachment 234778 [details]
Remove portsnap

Although we are still generating portsnap deltas it is no longer the recommended methods and git should be promoted. So remove references to portsnap. Additionally

- Remove training whitespace
- Remove trailing consecutive blank lines
Comment 1 Pau Amma 2022-06-19 16:06:24 UTC
Has there been a decision to use git over gitup?
Comment 2 Pau Amma 2022-06-19 17:21:57 UTC
(In reply to Muhammad Moinur Rahman from comment #0)

I distinctly remember that when I worked on that 2 years ago (https://reviews.freebsd.org/D25800, https://reviews.freebsd.org/D25801, https://reviews.freebsd.org/D25803/, https://reviews.freebsd.org/D25805, and https://reviews.freebsd.org/D25808), bcr@ (or maybe someone else from doceng@) specifically told me not to remove portsnap altogether yet. doceng@, is it time to revisit that decision?
Comment 3 Kubilay Kocak freebsd_committer freebsd_triage 2022-06-19 22:57:49 UTC
Can anyone point to comms/anything that outlines or summarizes the decision to deprecation portsnap?

There should also be a document (separate issue) that outlines that decision, roadmap and timeline, includes a communication piece to let people know whats changing, when the portsnap service will stop and what they have to do.
Comment 4 Muhammad Moinur Rahman freebsd_committer freebsd_triage 2022-06-19 23:19:52 UTC
(In reply to Kubilay Kocak from comment #3)
bug #255323 comment #14
Comment 5 Pau Amma 2022-06-20 01:38:27 UTC
(In reply to Kubilay Kocak from comment #3)

Based on my email archives, swills requested that in IRC (EFNet #bsddocs), IIRC in June or July 2020. What then happened:

- When I started working on it, I started doing as they asked and removing all references to portsnap, which I was told was slated for removal in 13.0. (That didn't happen and portsnap is alive and well - FSVO - in 13.1.)
- I then hit a snag when it came to updating the ezjail section, because there was essentially no good alternative to portsnap for it. I brought it up in IRC and was advised to ask doceng@ what to do.
- bcr@ told me in reply to my email to keep mentions of portsnap in but restrict their use to 12.x (explaining it was established doc practice and giving historical background), so I did that instead. Their reply was also sent to doceng@, so if that list has archives, a copy of the exchange together with any related internal discussion should be the July 2020 archives.
Comment 6 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2022-10-08 10:13:11 UTC
Approved. Thanks for the patch!
Comment 7 commit-hook freebsd_committer freebsd_triage 2022-10-09 17:00:50 UTC
A commit in branch main references this bug:

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

commit 6feb98a1718ebd4abf0c4cfc0445c1be3337db1a
Author:     Muhammad Moinur Rahman <bofh@FreeBSD.org>
AuthorDate: 2022-10-09 16:57:41 +0000
Commit:     Muhammad Moinur Rahman <bofh@FreeBSD.org>
CommitDate: 2022-10-09 16:57:41 +0000

    handbooks: Remove references to portsnap

    Although we are still generating portsnap deltas it is no longer the
    recommended methods and git should be promoted. So remove references to
    portsnap. Additionally

    - Remove training whitespace
    - Remove trailing consecutive blank lines

    By no means this is an indication that portsnap is going to be removed
    from the base or that portmgr@ is going to stop producing deltas. This
    is just to demote the usages of portsnap and promote git.

    PR:             264763
    Approved by:    carlavilla (mentor)

 .../content/en/articles/linux-users/_index.adoc    |  8 ++--
 .../content/en/books/handbook/jails/_index.adoc    |  4 +-
 .../content/en/books/handbook/mirrors/_index.adoc  |  4 +-
 .../content/en/books/handbook/ports/_index.adoc    | 49 +---------------------
 .../en/books/porters-handbook/testing/_index.adoc  | 14 ++-----
 website/content/en/ports/installing.adoc           |  2 +-
 6 files changed, 13 insertions(+), 68 deletions(-)
Comment 8 Graham Perrin 2023-08-26 10:50:17 UTC
See also: bug 273359

----

Triage (post-closure): 

* freebsd-doc (doc@), previously an assignee, should have become a 
  CC recipient when the assignee changed

– consistent with <https://wiki.freebsd.org/Bugzilla/TriageTraining#notify>.