Opened 16 years ago

Closed 9 years ago

Last modified 8 years ago

#18133 closed defect (fixed)

/opt/local/bin/port documentation problems

Reported by: macosforge.org@… Owned by: macports-tickets@…
Priority: Normal Milestone: MacPorts 2.4.0
Component: base Version: 1.7.0
Keywords: help man Cc: sewebster@…
Port:

Description

there are a number of minor problems with the port command's documentation.

1) the usage text differs between "port help" and the man page. help:

port
        [-bcdfiknopqRstuvx] [-D portdir] [-F cmdfile] action [privopts] [actionflags]
        [[portname|pseudo-portname|port-url] [@version] [+-variant]... [option=value]...]...

man page:

     port [-vdqfonRusbckixpt] [-D portdir] [-F cmdfile] [action] [actionflags]
          [[portname | pseudo-portname | port-url]]
          [[@version] [+/-variant ...] ... [option=value ...]]

2) "actions" aren't consistently referred to as "actions". the help text refers to "commands". the man page talks about "USER TARGETS".

3) the pseudo-portname "outdated" is listed as a command in the help text.

4) the help text lists "work" as a command.

there are likely other inconsistencies, too.

Change History (6)

comment:1 Changed 16 years ago by raimue (Rainer Müller)

port outdated and port work are actions. outdated is both an action and a pseudo-port, as also is installed.

comment:2 Changed 16 years ago by raimue (Rainer Müller)

Keywords: help man added
Milestone: Port BugsMacPorts Future

comment:3 Changed 14 years ago by sewebster@…

Cc: sewebster@… added

Cc Me!

comment:4 Changed 14 years ago by sewebster@…

1) is a trivial fix... action should be in square braces in the help text and privopts can probably be removed or be added to the man page. 2) I don't see any reference to "commands" in the help text anymore. Targets I guess reflect the internal macports code, but action is more suitable for (at least the beginning of) the man page since it has a more obvious meaning for the average user. I suppose all mention of targets could be removed from the man page, probably a search and replace target->action would even work. Or the current structure could be kept, where action is used initially to provide clarity and eventually the more correct target terminology is used, possibly with an explanatory sentence. 3) and 4) are not issues as explained by raimue above.

comment:5 Changed 9 years ago by neverpanic (Clemens Lang)

Resolution: fixed
Status: newclosed

I think the remaining issues are now obsolete since port help no longer prints messages but opens manpages, which have been re-written from scratch.

comment:6 Changed 8 years ago by jmroot (Joshua Root)

Milestone: MacPorts FutureMacPorts 2.4.0
Note: See TracTickets for help on using tickets.