Project

General

Profile

Support #15546

cetskelgen help should have one or two complete command line examples

Added by Gianluca Petrillo almost 4 years ago. Updated almost 4 years ago.

Status:
Assigned
Priority:
Normal
Assignee:
Christopher Green
Category:
Documentation
Target version:
-
Start date:
02/14/2017
Due date:
% Done:

0%

Estimated time:
Scope:
Internal
Experiment:
-
SSI Package:
cetlib
Duration:

Description

I received feedback of a user scared by the help page.

It is custom to have an "EXAMPLES" section at the end. Something like:

  cetskelmod  producer myreco::MyProducer

  creates a skeleton in MyProducer_module.cc with the art producer myreco::MyProducer in it, in the current directory and using the default options.

  cetskelmod -e beginJob -e endJob --dir myservice service myserv::MyService

  creates a skeleton in myservice/MyService_service.cc with the class myserv::MyService in it. This class already contains placeholders for the standard beginJob() and endJob() methods (see --entry option above).

Also, the --output-dir option should specify that the destination directory is required to already exist.

(incidentally, I get quite a number of confusing warnings when using it in OSX (perl 5.18.2))

History

#1 Updated by Kyle Knoepfel almost 4 years ago

  • Status changed from New to Assigned
  • Assignee set to Christopher Green

The request seems eminently sensible.

Also available in: Atom PDF