Bug 165250

Summary: "5.5.4.3 Upgrading Ports using Portmanager" should be clearer about flags
Product: Documentation Reporter: slasiewski
Component: Books & ArticlesAssignee: Benedict Reuschling <bcr>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
portmanager.diff none

Description slasiewski 2012-02-17 19:20:17 UTC 
The documentation at http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html#PORTMANAGER says the following:

    "All the installed ports can be upgraded using this simple command:
    
        # portmanager -u
    
    You can add the -ui flag to get asked for confirmation of every step Portmanager will perform."

This documentation is a bit vague and seems to be implying that I can try `portmanager -ui`. However, that returns an error:

    # portmanager -ui
    rParseCommandLine 0.4.1_9 error: /usr/ports/-ui is not a valid port directory
    rParseCommandLine 0.4.1_9 info:either you have used an invalid command line switch as the first option or you are trying to update a non existent port path, see man portmanager(1) 
    MGPMrCommandLine 0.4.1_9 error: rParseCommandLine returned errorCode 1

The correct flags are `portmanager -u -ui`:

    # portmanager -u -ui
    ------------------------------------------------------------------------
    portmanager 0.4.1_9: Collecting installed port data 
    ------------------------------------------------------------------------
    ...

Fix: 

Can you please make the documentation clearly state that the proper flags should be `-u -ui` and not `-ui`.

Perhaps the following is more clear:

Old:

"You can add the -ui flag to get asked for confirmation of every step Portmanager will perform."

New:

"You can add the -ui ('portmanager -u -ui')flag to get asked for confirmation of every step Portmanager will perform."
Comment 1 Isabell Long 2012-02-19 20:05:21 UTC 
Hi,

On Fri, Feb 17, 2012 at 07:18:44PM +0000, Stefan Lasiewski wrote:

[...]

> Can you please make the documentation clearly state that the proper flags should be `-u -ui` and not `-ui`.

Thanks for the report - attached is a patch.

Isabell.
Comment 2 Benedict Reuschling freebsd_committer freebsd_triage 2012-02-19 21:06:14 UTC 
Responsible Changed
From-To: freebsd-doc->bcr

I will get this fixed.
Comment 3 dfilter service freebsd_committer freebsd_triage 2012-02-20 19:09:48 UTC 
bcr         2012-02-20 19:09:35 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/ports chapter.sgml 
  Log:
  Clear up the description of the portmanager flags: it should be
  -u -ui rather than just -ui.
  
  PR:             docs/165250
  Submitted by:   Stefan Lasiewski (slasiewski lbl gov)
  Patch by:       Isabell Long (isabell121 gmail com)
  
  Revision  Changes    Path
  1.297     +3 -1      doc/en_US.ISO8859-1/books/handbook/ports/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 4 Benedict Reuschling freebsd_committer freebsd_triage 2012-02-20 19:19:38 UTC 
State Changed
From-To: open->closed

Patch was committed without modifications. Thanks for reporting this and 
providing the patch, respectively. Good teamwork! PR closed.