dev/package/files

package file introspection and management

dev/package/files: Library Dependencies

View the full-size SVG (svg) or PDF (pdf) image or graphviz source (dot)

View color source code (raw) for this file

View reStructuredText (rst) source code for this page

Library Configuration

`$package_file_kinds[]`

Lists valid kinds of package files. Defaults: dist package sources configs tools libs

Package source file kinds

`package_file_kind_valid()`

Returns success if argument is valid kind of package file.

$1 - Kind of package file

`package_file_kind_dir()`

Prints package directory for a given kind of package file ($1). Only implemented for tools, libs, and configs.

`package_file_kind_ext()`

Prints file extension for a given file kind ($1). Only implemented for tools, libs, and configs.

Package Source Files

`package_file_name()`

Prints the path for a given kind of package file ($1) and name ($2).

`package_files()`

Prints all names of package files of the given kind ($1).

`package_files_dist()`

Prints all names of all package distribution content by calling find(1) on the files specified by the package configuration files (e.g. package.i7). The resulting list includes all directory and file names.

$@ - Passed along to find, allowing this raw list to be refined: further by the remaining functions in this section.

`package_files_package()`

Prints names of all plain package files.

`package_files_sources()`

Prints names of all package source code files.

`package_files_configs()`

Prints names of package configuration scripts.

`package_files_tools()`

Prints names of package tool scripts.

`package_files_libs()`

Prints names of package library scripts.

`package_files_extension()`

Prints names of package extension files.

Package File Arguments

`package_sources_or_args()`

Saves arguments ($@) in named array ($1). If none given, saves the list of package sources.

Package File Iteration

`with_package_files`

Run a command with all package files

$1 - Kind of files to use: dist, package, sources, configs, tools, libs

$2 - Command to run

$@ - Command arguments (optional)

`with_each_package_file`

Run a command with each package file