Module filelist: file list utilities

This module contains framework for creating and improving file lists.

Module defines phase: filelist_install after INSTALL_CHECK

Module uses phase: filelist_install after INSTALL_CHECK

Module defines phase: filelist_raw after CHECKINSTALL

Module uses phase: filelist_raw after CHECKINSTALL

Module defines phase: filelist_clean after filelist_raw

Module uses phase: filelist_clean after filelist_raw

Module defines phase: filelist_inspect after filelist_clean

Module defines phase: filelist_finish after filelist_inspect

filelist_install

Generates preliminary file list in install phase.

filelist_raw

Calls $filelist_raw_provider_function to get raw file list.

Raw file list name for list creator process.

Module provides function for: $filelist_raw_function

filelist_clean

Cleans file list (canonicalize path, remove duplicates and some accesses).

File list name for inspect processes.

Temporary file name for inspect processes.

filelist_raw_open

Open raw filelist file for output in stdout. Used by filelist_raw_provider function.

filelist_raw_close

Close raw filelist file in stdout. Used by filelist_raw_provider function.

filelist_raw_provider

Function for init of module providing filelist_raw function. Function will be named {module}_filelist_raw.

WARNING: This function cannot be called outside module init.

Module provides function for: function filelist_raw {

Module provides function for: filelist_raw_function=${pwiz_module_current}_filelist_raw

filelist_inspect_provider

Function for init of modules providing filelist_inspect function. Function will be named {module}_filelist_inspect.

Module provides function for: function filelist_inspect {

Module uses phase: filelist_inspect

filelist_install_provider

Function for init of modules providing filelist_install function. Function will be named {module}_filelist_install.

Module provides function for: function filelist_install {

Module uses phase: filelist_install

filelist_generate

Generate file list on request. Clean list is generated, but no inspectors are called.

filelist_read_open [ stream ]

stream: stream number to be opened for read (default 3)

Function opens filelist for reading in defined stream.

filelist_read_close [ stream ]

stream: stream number to be closed (default 3)

Closes defined stream.

filelist_read_item [ stream ]

stream: stream number from where to read item (default 3)

returns $filelist_tag_name: list item file or directory name

returns $filelist_tagline: part of line with all tags and type (for special purposes or verbatim copying)

returns $filelist_tag_{key}: returns value of tags associated with list item

Reads list item from opened stream.

Known tags variables:

$filelist_tag_type: type of object ("file", "dir", "read")

$filelist_tag_cat: attributes of file in package (not permissions, but attributes like doc, man, noverify etc.)

$filelist_tag_sub: subpackage

Filelist line format (for writing to list):

filename type@sub=subname@cat=doc
filename2 type

filelist_split_candidate sub ...

sub: split candidate name

Suggests candidate for splitting package to subpackages.

Purpose of this functions: In time of inspection, we don't know, whether such subpackage will be really created or not, but we need candidate name to be able to detect files in system owned by this package and possible subpackages.

filelist_split_candidate_prerequires sub what_requires

sub: split candidate name

what_requires: list of prerequirements

Set prerequirements (i. e. packages needed for installation) of subpackage, if it will be created.

filelist_split_candidate_requires sub what_requires

sub: split candidate name

what_requires: list of requirements

Set requirements (i. e. packages needed for using) of subpackage, if it will be created.