metaonly module xdc.tools.repoman.Main
index URL

Command implementation

This tool creates and manages package repositories. It displays information about archived packages, extracts archived packages, extracts repositories from bundles and deletes packages from repositories. [ more ... ]
XDCscript usage meta-domain sourced in xdc/tools/repoman/Main.xdc
var Main = xdc.useModule('xdc.tools.repoman.Main');
module-wide constants & types
    var obj = new Main.NameResults// ;
        obj.pkgName// array of PkgName structures = Main.PkgName[]  ...
 
    var obj = new Main.Pkg// ;
        obj.name = String  ...
        obj.file = String  ...
        obj.release = String  ...
        obj.label = String  ...
        obj.version = String  ...
        obj.date = String  ...
        obj.buildable = String  ...
        obj.originalProviderId = String  ...
        obj.producerId = String  ...
        obj.reqs = String[]  ...
        obj.refs = String[]  ...
        obj.repository = Main.Repo[]  ...
 
    var obj = new Main.PkgName// ;
        obj.name = String  ...
        obj.repository = Main.Repo[]  ...
 
    var obj = new Main.Repo// represents a repository in a bundle;
        obj.name = String  ...
        obj.pkg = String[]  ...
 
    var obj = new Main.Results// ;
        obj.repository = String  ...
        obj.providerId = String  ...
        obj.producerId = String  ...
        obj.writable = Bool  ...
        obj.pkg// array of package info structures = Main.Pkg[]  ...
module-wide config parameters
    Main.usage// Usage for this command = String[] [
        '-t [-v] [-p pathname] [packagename...|packagefile...]',
        '-n [-v] [-p pathname] [packagename...|packagefile...]',
        '-x [-v] [-D] [-R] [-F] [-r destrepo] [-p path] packagename...|packagefile...',
        '-x [-v] [-D] [-R] [-F] [-r destrepo] [-p path] -b bundlerepository [packagename...] bundleFile',
        '-d [-v] [-F] [-r destrepo] packagename...',
        '-c [-v] [-F] [--providerId] [-r destrepo] [-p pathname] packagename...',
        '--rsave -f file [-p searchpath] repository...',
        '--rrestore -f file [-p searchpath] [index-spec]',
        '--rcreate -f file [-p searchpath] [index-spec] destrepository...',
        '[-F] --providerId providerId [repository...]'
    ];
module-wide functions
    Main.exec// 'xs' script entry point(Any args) returns Any
    Main.main// 'xs' shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.arrFlag// Return an array of strings = Bool false;
        params.bundleRepositoryArg// Bundle repository arg = String null;
        params.copyFlag// Copy package(s) = Bool false;
        params.deleteFlag// Delete package(s) = Bool false;
        params.dependentFlag// Include package dependencies = Bool false;
        params.extractFlag// Extract package(s) = Bool false;
        params.fileArg// file arg to save/restore repository = String null;
        params.forceFlag// Force incompatible packages = Bool false;
        params.infoFlag// Display package info = Bool false;
        params.namesFlag// Display package names only = Bool false;
        params.pathArg// Path arg = String null;
        params.provIdArg// providerId for a repository = String null;
        params.rcreateFlag// Create one or more repositories from information in file = Bool false;
        params.recursiveDepFlag// Recursive include package dependencies = Bool false;
        params.repositoryArg// Repository arg = String null;
        params.rrestoreFlag// Restore one or more repositories from information in file = Bool false;
        params.rsaveFlag// Save a repository's information to file = Bool false;
        params.verboseFlag// Print informative messages during execution = Bool false;
        params.xmlFlag// Return a Results struct as XML = Bool false;
per-instance functions
    inst.run// Underlying implementation(Cmdr.Instance cmdr, String[] args) returns Any
 
DETAILS
This tool creates and manages package repositories. It displays information about archived packages, extracts archived packages, extracts repositories from bundles and deletes packages from repositories.
Information about archived packages can be displayed with the '-t' and '-n' options. The '-p' argument is used to specify a directory in which to search. If the '-p' arg is omitted, the current directory is searched. Specific packages can searched for by specifying one or more package names, or one or more package archives at the end of the command line. If no packages are specified, information on all packages found in the search directory will be displayed.
Archived packages can be extracted to a repository with the '-x' option. '-x -D' will extract dependent packages, too. '-x -R' will recursively extract dependent packages. If any of the packages in the specified package list are not compatible, the operation will be aborted. '-F' can be used to force all packages to be extracted, regardles of compatibility. The '-p' arg is used to specify a directory to search in. If not specified, the current directory will be searched. The '-x' option also extracts a repository or packages from a bundle. In this case, the last argument specifies the bundle from which to extract the repository. The repository to be extracted is specified with the '-b' arg. If just packages are to be extracted, one or more package names should follow the name of the repository that they should be extracted from.
Packages can be deleted from a repository with '-d'. If the package has any subdirectores that contain packages, they will be left intact. After the package is deleted, if the package has no subdirectories with packages, empty directories that are part of the fully qualified package will be deleted, too.
Packages can be copied between repositories with '-c'. If the package being copied already exists in the destination repository, it will be deleted prior to being replaced.
The '-r' argument specifies a destination repository. If '-r' is omitted, the repository of the current package is used. If there is no current package, the current directory is used.
When a package name is given, it can be specified in full, such as 'ti.platforms.sim6xxx', or the wildcard characters '*' and '?' may be used, as in 'ti.platforms.*' or 'ti.catalog.c??00'. A version/key can also be attached to a package name in the following manner: 'ti.platforms.c6000[1,0,0,0,313835]'. A prefix of the full version/key may also be used: 'ti.platforms.c6000[1,0]'.
If a package name has multiple matches either with or without a version/key specified, the most recent will be selected. Wildcards may also be used when naming a package archive file.
EXAMPLES
xs xdc.tools.repoman -t
Displays all info on all archived packages in the current directory
xs xdc.tools.repoman -t -p C:\xdc-o19\exports
Displays all info on all archived packages in C:\xdc-o19\exports
xs xdc.tools.repoman -t -p C:\xdc-o19\exports ti.platforms.*
Displays all info on archived packages whose names begin with ti.platforms. in C:\xdc-o19\exports
xs xdc.tools.repoman -t -p C:\xdc-o19\exports ti_platforms*.tar
Displays all info on packages in files that match ti_platforms*.tar in C:\xdc-o19\exports
xs xdc.tools.repoman -t -p C:\xdc-o19\exports ti.catalog.c6000 ti.catalog.sim6xxx
Displays all info on archived packages ti.catalog.c6000 and ti.catalog.sim6xxx in C:\xdc-o19\exports
xs xdc.tools.repoman -t http://www.sanb.design.ti.com/ti_sdo_ce_wizards_genserver.tar
Displays all info on archived package ti_sdo_ce_wizards_genserver.tar at URL http://www.sanb.design.ti.com
xs xdc.tools.repoman -x
Extracts all archived packages in the current directory to the current repository
xs xdc.tools.repoman -x -r C:\myrepo\packages -p C:\exports
Extracts all archived packages in C:\exports to C:\myrepo\packages repository
xs xdc.tools.repoman -x -r C:\myrepo\packages -p C:\exports ti.catalog.*
Extracts packages matching ti.catalog.* from c:\exports to c:\myrepo\packages
xs xdc.tools.repoman -x -r C:\myrepo\packages C:\exports\ti_catalog*.tar
Extracts packages from files matching C:\exports\ti_catalog*.tar to c:\myrepo\packages
xs xdc.tools.repoman -x -r C:\myrepo\packages C:\exports\ti_catalog*.tar
Extracts packages from files matching C:\exports\ti_catalog*.tar to c:\myrepo\packages
xs xdc.tools.repoman -x -R -r C:\myrepo -p C:\xdc-o19\exports ti.platforms.sim6xxx
Extracts the package ti.platforms.sim6xxx and all recursively dependent packages from C:\xdc-o19\exports to C:\myrepo
xs xdc.tools.repoman -x -r C:\ -b packages C:\exports\xdc_core.tar.gz
Extracts the repository 'packages' from bundle C:\exports\xdc_core.tar.gz to C:\
xs xdc.tools.repoman -x -r C:\myrepo -b examples ti.xdais.dm.examples.videnc1_copy C:\xdais_6_24.tar.gz
Extracts the package ti.xdais.dm.examples.videnc1_copy from repository 'examples' in bundle C:\xdais_6_24.tar.gz to C:\myrepo
xs xdc.tools.repoman -x -r C:\myrepo http://www.sanb.design.ti.com/ti_sdo_ce_wizards_genserver.tar
Extracts package ti_sdo_ce_wizards_genserver.tar at URL http://www.sanb.design.ti.com to c:\myrepo
xs xdc.tools.repoman -r C:\myrepo -b examples https://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/xdais/7_10/exports/xdais_7_10.tar.gz
Extracts all of the packages in repository 'examples' from bundle xdais_7_10.tar.gz at URL http://... to C:\myrepo
xs xdc.tools.repoman -x -r C:\myrepo -b examples ti.xdais.dm.examples.videnc1_copy https://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/xdais/6_24/exports/xdais_6_24.tar.gz
Extracts the package ti.xdais.dm.examples.videnc1_copy in repository 'examples' from bundle xdais_7_10.tar.gz at URL http://... to C:\myrepo
xs xdc.tools.repoman -c -r C:\destdir\packages -p C:\srcdir\packages ti.catalog.c6000
Copies the package ti.catalog.c6000 from C:\srcdir\packages to C:\destdir\packages
xs xdc.tools.repoman --rsave -f c:/repoinfo.rmn -p c:/pkgarchives;c:/testpkgs c:/myrepo
Saves package information for repository c:/myrepo to file c:/repoinfo.rmn. Also saves the search path c:/pkgarchives;c:/testpkgs
xs xdc.tools.repoman --rrestore -f c:/repoinfo.rmn -p c:/pkgarchives;c:/testpkgs
Restores all of the packages in the repository referenced in c:/repoinfo.rmn. Uses the search path c:/pkgarchives;c:/testpkgs to find and copy packages. Will create the repository if it doesn't exist.
xs xdc.tools.repoman --rcreate -f c:/repoinfo.rmn -p c:/pkgarchives;c:/testpkgs c:/mynewrepo
Creates the new repository c:/mynewrepo from the repository referenced in the file c:/repoinfo.rmn. Uses the search path c:/pkgarchives;c:/testpkgs to find and copy packages. If successful, the newly created repository will be identical to its predecessor referenced in c:/repoinfo.rmn.
xs xdc.tools.repoman --providerId my_codec_engine c:/codec_engine_2_23/mypackages
Assigns the providerId attribute in c:/codec_engine_2_23/mypackages/.repo.xml the value my_codec_engine. If c:/codec_engine_2_23/mypackages/.repo.xml does not exist, it will be created.
 
struct Main.NameResults
index URL
XDCscript usage meta-domain
var obj = new Main.NameResults;
 
    obj.pkgName = Main.PkgName[]  ...
    // array of PkgName structures
 
 
struct Main.Pkg
index URL
XDCscript usage meta-domain
var obj = new Main.Pkg;
 
    obj.name = String  ...
    obj.file = String  ...
    obj.release = String  ...
    obj.label = String  ...
    obj.version = String  ...
    obj.date = String  ...
    obj.buildable = String  ...
    obj.originalProviderId = String  ...
    obj.producerId = String  ...
    obj.reqs = String[]  ...
    obj.refs = String[]  ...
    obj.repository = Main.Repo[]  ...
 
 
struct Main.PkgName
index URL
XDCscript usage meta-domain
var obj = new Main.PkgName;
 
    obj.name = String  ...
    obj.repository = Main.Repo[]  ...
 
 
struct Main.Repo
index URL

represents a repository in a bundle

XDCscript usage meta-domain
var obj = new Main.Repo;
 
    obj.name = String  ...
    obj.pkg = String[]  ...
 
 
struct Main.Results
index URL
XDCscript usage meta-domain
var obj = new Main.Results;
 
    obj.repository = String  ...
    obj.providerId = String  ...
    obj.producerId = String  ...
    obj.writable = Bool  ...
    obj.pkg = Main.Pkg[]  ...
    // array of package info structures
 
 
config Main.usage  // module-wide
index URL

Usage for this command

XDCscript usage meta-domain
Main.usage = String[] [
    '-t [-v] [-p pathname] [packagename...|packagefile...]',
    '-n [-v] [-p pathname] [packagename...|packagefile...]',
    '-x [-v] [-D] [-R] [-F] [-r destrepo] [-p path] packagename...|packagefile...',
    '-x [-v] [-D] [-R] [-F] [-r destrepo] [-p path] -b bundlerepository [packagename...] bundleFile',
    '-d [-v] [-F] [-r destrepo] packagename...',
    '-c [-v] [-F] [--providerId] [-r destrepo] [-p pathname] packagename...',
    '--rsave -f file [-p searchpath] repository...',
    '--rrestore -f file [-p searchpath] [index-spec]',
    '--rcreate -f file [-p searchpath] [index-spec] destrepository...',
    '[-F] --providerId providerId [repository...]'
];
 
 
Main.exec()  // module-wide
index URL

'xs' script entry point

XDCscript usage meta-domain
Main.exec(Any args) returns Any
 
 
Main.main()  // module-wide
index URL

'xs' shell entry point

XDCscript usage meta-domain
Main.main(Any args) returns Any
 
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.arrFlag = Bool false;
    // Return an array of strings
    params.bundleRepositoryArg = String null;
    // Bundle repository arg
    params.copyFlag = Bool false;
    // Copy package(s)
    params.deleteFlag = Bool false;
    // Delete package(s)
    params.dependentFlag = Bool false;
    // Include package dependencies
    params.extractFlag = Bool false;
    // Extract package(s)
    params.fileArg = String null;
    // file arg to save/restore repository
    params.forceFlag = Bool false;
    // Force incompatible packages
    params.infoFlag = Bool false;
    // Display package info
    params.namesFlag = Bool false;
    // Display package names only
    params.pathArg = String null;
    // Path arg
    params.provIdArg = String null;
    // providerId for a repository
    params.rcreateFlag = Bool false;
    // Create one or more repositories from information in file
    params.recursiveDepFlag = Bool false;
    // Recursive include package dependencies
    params.repositoryArg = String null;
    // Repository arg
    params.rrestoreFlag = Bool false;
    // Restore one or more repositories from information in file
    params.rsaveFlag = Bool false;
    // Save a repository's information to file
    params.verboseFlag = Bool false;
    // Print informative messages during execution
    params.xmlFlag = Bool false;
    // Return a Results struct as XML
 
config Main.arrFlag  // instance
index URL

Return an array of strings

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.arrFlag = Bool false;
 
 
config Main.bundleRepositoryArg  // instance
index URL

Bundle repository arg

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.bundleRepositoryArg = String null;
 
 
config Main.copyFlag  // instance
index URL

Copy package(s)

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.copyFlag = Bool false;
 
 
config Main.deleteFlag  // instance
index URL

Delete package(s)

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.deleteFlag = Bool false;
 
 
config Main.dependentFlag  // instance
index URL

Include package dependencies

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.dependentFlag = Bool false;
 
 
config Main.extractFlag  // instance
index URL

Extract package(s)

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.extractFlag = Bool false;
 
 
config Main.fileArg  // instance
index URL

file arg to save/restore repository

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.fileArg = String null;
 
 
config Main.forceFlag  // instance
index URL

Force incompatible packages

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.forceFlag = Bool false;
 
 
config Main.infoFlag  // instance
index URL

Display package info

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.infoFlag = Bool false;
 
 
config Main.namesFlag  // instance
index URL

Display package names only

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.namesFlag = Bool false;
 
 
config Main.pathArg  // instance
index URL

Path arg

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.pathArg = String null;
 
 
config Main.provIdArg  // instance
index URL

providerId for a repository

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.provIdArg = String null;
 
 
config Main.rcreateFlag  // instance
index URL

Create one or more repositories from information in file

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.rcreateFlag = Bool false;
 
 
config Main.recursiveDepFlag  // instance
index URL

Recursive include package dependencies

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.recursiveDepFlag = Bool false;
 
 
config Main.repositoryArg  // instance
index URL

Repository arg

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.repositoryArg = String null;
 
 
config Main.rrestoreFlag  // instance
index URL

Restore one or more repositories from information in file

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.rrestoreFlag = Bool false;
 
 
config Main.rsaveFlag  // instance
index URL

Save a repository's information to file

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.rsaveFlag = Bool false;
 
 
config Main.verboseFlag  // instance
index URL

Print informative messages during execution

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.verboseFlag = Bool false;
 
 
config Main.xmlFlag  // instance
index URL

Return a Results struct as XML

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.xmlFlag = Bool false;
 
 
Main.run()  // instance
index URL

Underlying implementation

XDCscript usage meta-domain
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
 
generated on Thu, 27 Sep 2012 23:21:17 GMT