Hello! I've extended the command line and would like to get feedback on the patch before merging into the command line. If you are a user of the command line, does the following change make sense to you?
Author: Patrick Ohly <[email protected]> 2011-11-21 17:38:34 Committer: Patrick Ohly <[email protected]> 2011-11-21 17:38:34 Parent: 2d591e780dcfb8470d16e28aa87b52d0b754b8de (config: return value + "was set" for each config property) Branch: pohly Follows: syncevolution-1-2 Precedes: command line: config and source names are optional (BMC #23783) The need to add "foo" and "bar" pseudo config and source names to the command line even when all parameters for the operation where explicitly specified on the command line was confusing. Now it is possible to invoke item operations without the config and source name. Names which refer to non-existent configs are still accepted, as in previous releases. Typos are handled better by producing a detailed error report which includes (as applicable): - config doesn't exist - source doesn't exist or not selected - backend property not set This error report is created only if SyncSource was unable to create a SyncSource, which is detected by catching the status exception with the right error code. Trying to anticipate the error at the Cmdline level would duplicate code found in the SyncSource and/or impose limitations which might not hold in all cases. Because luids used to be positional arguments after <config> and <source>, a new --luids keyword is necessary to indicate that the following parameters are luids and not <config> and <source>. Added a CmdlineTest::testItemOperations for this new command line syntax. It uses the file backend to run some real operations (missing earlier). Error reporting in the command line uses the same mix of writing error messages and returning early (Cmdline) and throwing exceptions (rest of SyncEvolution). Perhaps the Cmdline class should also use exceptions - but not now. ---------------------------------- README.rst ---------------------------------- index 16bb95c..b6de21f 100644 @@ -42,20 +42,23 @@ Create, update or remove a configuration: syncevolution --remove|--migrate <options> [--] <config> List items: - syncevolution --print-items [--] <config> <source> + syncevolution --print-items [--] [<config> [<source>]] Export item(s): - syncevolution [--delimiter <string>] --export <dir>|<file>|- [--] <config> <source> [<luid> ...] + syncevolution [--delimiter <string>] --export <dir>|<file>|- [--] [<config> [<source> [<luid> ...]]] + --luids <luid> ... Add item(s): - syncevolution [--delimiter <string>|none] --import <dir>|<file>|- [--] <config> <source> + syncevolution [--delimiter <string>|none] --import <dir>|<file>|- [--] [<config> [<source>]] + --luids <luid> ... Update item(s): syncevolution --update <dir> [--] <config> <source> syncevolution [--delimiter <string>|none] --update <file>|- [--] <config> <source> <luid> ... + --luids <luid> ... Remove item(s): syncevolution --delete-items [--] <config> <source> (<luid> ... | '*') @@ -419,10 +422,10 @@ the peer during the next synchronization. If the peer somehow needs to get a clean copy of all local items, then use ``--sync refresh-from-local`` in the next run. :: syncevolution --print-items <config> <source> - syncevolution [--delimiter <string>] --export <dir>|<file>|- <config> <source> [<luid> ...] - syncevolution [--delimiter <string>|none] --import <dir>|<file>|- <config> <source> + syncevolution [--delimiter <string>] --export <dir>|<file>|- [<config> [<source> [<luid> ...]]] + syncevolution [--delimiter <string>|none] --import <dir>|<file>|- [<config> <source>] syncevolution --update <dir> <config> <source> syncevolution [--delimiter <string>|none] --update <file>|- <config> <source> <luid> ... syncevolution --delete-items <config> <source> (<luid> ... | *) @@ -430,17 +433,24 @@ Restore depends on the specific format of the automatic backups created by SyncEvolution. Arbitrary access to item data is provided with additional options. <luid> here is the unique local identifier assigned to each item in the source, transformed so that it contains only alphanumeric characters, dash and underscore. A star * in ---delete-items selects all items for deletion. +--delete-items selects all items for deletion. There are two ways +of specifying luids: either as additional parameters after the +config and source parameters (which may be empty in this case, but +must be given) or after the ``--luids`` keyword. -<config> and <source> must be given, but they do not have to refer to -existing configurations. In that case, the desired backend and must be -give via the ``backend`` property, like this:: +<config> and <source> may be given to define the database which is to +be used. If not given or not refering to an existing configuration +(which is not an error, due to historic reasons), the desired backend +must be given via the ``backend`` property, like this:: - syncevolution --print-items backend=evolution-contacts dummy-config dummy-source + syncevolution --print-items backend=evolution-contacts + syncevolution --export - backend=evolution-contacts \ + --luids pas-id-4E33F24300000006 pas-id-4E36DD7B00000007 The desired backend database can be chosen via ``database=<identifier>``. +See ``--print-databases``. -- Best Regards, Patrick Ohly The content of this message is my personal opinion only and although I am an employee of Intel, the statements I make here in no way represent Intel's position on the issue, nor am I authorized to speak on behalf of Intel on this matter. _______________________________________________ SyncEvolution mailing list [email protected] http://lists.syncevolution.org/listinfo/syncevolution
