Bug 214679 - "Recommendation" for portmaster and portupgrade needs to be removed
Summary: "Recommendation" for portmaster and portupgrade needs to be removed
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Mark Linimon
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-11-19 23:43 UTC by John Marino
Modified: 2017-12-17 07:13 UTC (History)
5 users (show)

See Also:


Attachments
patch to Handbook chapter on ports (4.05 KB, patch)
2017-01-10 23:45 UTC, Mark Linimon
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description John Marino freebsd_committer 2016-11-19 23:43:13 UTC
Per precedent (bug 206922), statements that lead one to believe that portupgrade or portmaster tools are "recommended" need to be removed from documentation.

https://www.freebsd.org/doc/handbook/ports-using.html
Chapter 4.5.3. Upgrading Ports

Last line: "To perform the actual upgrade, use either Portmaster or Portupgrade."


Ways of addressing:
A) change to a generic statement (e.g. mention repository builder or build tool by description, not name)
B) list every possible current tool by name (e.g. add poudriere and synth, there could be others)
C) remove the line.  Is it needed?
Comment 1 Greg Lehey freebsd_committer 2016-11-21 02:50:37 UTC
A form of alternative B seems the most appropriate.  We gradually have a bewildering number of tools.  Which are still being maintained?  What are the advantages and disadvantages of each?  As I said in the previous PR, I don't believe we should be removing documentation for tools which are still available.
Comment 2 John Marino freebsd_committer 2016-11-21 04:56:06 UTC
Even if the line were removed completely, it wouldn't qualify as "removing documentation for the tool".  It's being interpreted as an official recommendation to use those specific tools, and it's recommendation that would be removed.

Option B is fine, but I would have thought option A or C would be preferable myself.
Comment 3 Baptiste Daroussin freebsd_committer 2016-12-18 15:17:44 UTC
I'm not portmgr anymore, so I would share what was discussed long ago.

While it is true portmaster and portupgrade are still in ports, none of them are still in active maintenance. We discussed a lot between portmgr about removing portmaster/portupgrade from the handbook.

Beside some drawbacks of those tools which yes could be documented as "pro/cons" for true, no active maintenance is also a problem regarding some evolution that are planned in the ports tree for very long: subpackages and alternative/flavours. which will break the design around which portupgrade and portmaster are built: a port is unique via its origin.

portmaster took years to catch up on pkg_install -> pkg transition (portupgrade was a bit faster to catch up due to active maintenance from bdrewery on portupgrade at the time).

I would vote on removing documentation of both tools in the handbook
Comment 4 Mark Linimon freebsd_committer freebsd_triage 2017-01-10 23:45:33 UTC
Created attachment 178735 [details]
patch to Handbook chapter on ports
Comment 5 Adam Weinberger freebsd_committer 2017-01-10 23:50:23 UTC
What will become the biggest benefit of poudriere and synth over port* is that port* are not actively updated and will break soon when major new features are added to the ports system.
Comment 6 Torsten Zuehlsdorff freebsd_committer 2017-01-11 11:15:20 UTC
Looks fine to me :)
Comment 7 vali gholami 2017-12-17 07:13:00 UTC
MARKED AS SPAM