Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 136908 - emerge tells to use --help config instead of --config
Summary: emerge tells to use --help config instead of --config
Status: RESOLVED DUPLICATE of bug 137483
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Core - Interface (emerge) (show other bugs)
Hardware: All Linux
: High trivial (vote)
Assignee: Portage team
URL:
Whiteboard:
Keywords:
: 137592 (view as bug list)
Depends on:
Blocks:
 
Reported: 2006-06-15 09:46 UTC by Flammie Pirinen (RETIRED)
Modified: 2007-08-08 14:30 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
changes "--help config" to "help --protect", also in the docs (emerge--help-on-config-protect.patch,3.11 KB, patch)
2006-07-09 04:30 UTC, Benno Schulenberg
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Flammie Pirinen (RETIRED) gentoo-dev 2006-06-15 09:46:24 UTC
The current version of emerge does
print " "+yellow("*")+" Type "+green("emerge --help config")+" to learn how to update config files."
in the end of successful emerge, but running `emerge --help config` in portage 2.1 tells "*** Deprecated use of action 'config', use '--config' instead". I assume the former needs to be updated.
Comment 1 Zac Medico gentoo-dev 2006-06-15 10:11:41 UTC
Well, the --config option is actually something competely different from what is described by `emerge --help config`.  Perhaps we should drop the `emerge --help config` feature and simply document it in the portage.5 man page.
Comment 2 Alec Warner (RETIRED) archtester gentoo-dev Security 2006-06-22 07:48:58 UTC
*** Bug 137592 has been marked as a duplicate of this bug. ***
Comment 3 Wiktor Wandachowicz 2006-07-08 06:13:51 UTC
Today I also noticed the warning:

# emerge --help config
*** Deprecated use of action 'config', use '--config' instead
Config file management support (preliminary)
...

To my surprise the below command also worked, but without a warning:

# emerge --help --config
Config file management support (preliminary)
...

Overall this surprised me a bit, so I began to dig deeper. Obviously, 'emerge --help config' and 'emerge --help --config' mean that "config" or "--config" is a parameter to the "--help" option. Even Subversion has the notion of documenting its commands in a similar way, although it's "svn help <command>".

Recent changes in portage (emerge?) wrt. prefixing parameters with double dashes, like 'emerge --sync' in favor of 'emerge sync' do seem reasonable. But 'emerge --help --config' or 'emerge --help --sync' (without warnings) in favor of well documented, old-style (but with warnings) 'emerge --help config' or 'emerge --help sync' may confuse (a bit) some users.

OTOH the new syntax is consistent with the new style actions, so I appreciate that. Currently it's "emerge --sync" and "emerge --config <package>", so asking for help regarding these example actions with "emerge --help --<action>" also seem reasonable.


(And in reply to comment #1)
> Perhaps we should drop the `emerge --help config` feature
> and simply document it in the portage.5 man page.

This would break the "compatibility" with existing docs on the net. I've found several of them claiming that 'emerge --help config' is the way to get more help on the CONFIG_PROTECT feature. That's how I stumbled upon this warning in the first place. IMHO the warning should be kept and logic for processing emerge's parameters could be enhanced, instead of silently dropping features.

Text of the warning could also be changed, stating verbosely that "emerge --help config" is incorrect and "emerge --help --config" should be used. Currently the warning is consistent with the "emerge config <sth>", but not with the "emerge --help config". How about this one?

*** Deprecated use of action '--help config', use '--help --config' instead

And if the relevant information is ever going to be moved to the man page (which is completely valid from my POV), the old behaviour still could work but the text displayed should point users to the correct man page.
Comment 4 Benno Schulenberg 2006-07-09 04:30:54 UTC
Created attachment 91266 [details, diff]
changes "--help config" to "help --protect", also in the docs

> Text of the warning could also be changed, stating verbosely that "emerge
> --help config" is incorrect and "emerge --help --config" should be used.

As comment #1 says: "--config" has nothing to do with "--help config".  The patch proposes to change the latter to "--help protect".
Comment 5 Marius Mauch (RETIRED) gentoo-dev 2007-08-08 14:30:29 UTC

*** This bug has been marked as a duplicate of bug 137483 ***