Class Requires

  action.Action --+                
                  |                
action.RecipeAction --+            
                      |            
      policy.BasePolicy --+        
                          |        
              policy.Policy --+    
                              |    
                       _addInfo --+
                                  |
  action.Action --+               |
                  |               |
action.RecipeAction --+           |
                      |           |
      policy.BasePolicy --+       |
                          |       |
              policy.Policy --+   |
                              |   |
                    _dependency --+
                                  |
                                 Requires

Known Subclasses:

derivedpolicy.Requires, _basePluggableRequires

NAME

SYNOPSIS

DESCRIPTION

The r.Requires() policy adds requirements for a file. You can pass in exceptions that should not have automatic requirement discovery done, such as example shell scripts outside of %(docdir)s.

Note: Components are the only troves which can be required.

For executables executed only through wrappers that use LD_LIBRARY_PATH to find the libraries instead of embedding an RPATH in the binary, you will need to provide a synthetic RPATH using r.Requires(rpath='RPATH') or r.Requires(rpath=('filterExp', 'RPATH')) calls, which are tested in the order provided.

The RPATH is a standard Unix-style path string containing one or more directory names, separated only by colon characters, except for one significant change: Each path component is interpreted using shell-style globs, which are checked first in the %(destdir)s and then on the installed system. (The globs are useful for cases like perl where statically determining the entire content of the path is difficult. Use globs only for variable parts of paths; be as specific as you can without using the glob feature any more than necessary.)

Executables that use dlopen() to open a shared library will not automatically have a dependency on that shared library. If the program unconditionally requires that it be able to dlopen() the shared library, encode that requirement by manually creating the requirement by calling r.Requires('soname: libfoo.so', 'filterexp') or r.Requires('soname: /path/to/libfoo.so', 'filterexp') depending on whether the library is in a system library directory or not. (It should be the same as how the soname dependency is expressed by the providing package.)

For unusual cases where a system library is not listed in ld.so.conf but is instead found through a search through special subdirectories with architecture-specific names (such as i686 and tls), you can pass in a string or list of strings specifying the directory or list of directories. with r.Requires(sonameSubtrees='/directoryname') or r.Requires(sonameSubtrees=['/list', '/of', '/dirs'])

Note: These are not regular expressions. They will have macro expansion expansion performed on them.

EXAMPLES

r.Requires('mailbase:runtime', '%(sbindir)s/sendmail')

Demonstrates using r.Requires to specify a manual requirement of the file %(sbindir)s/sendmail to the :runtime component of package mailbase.

r.Requires('file: %(sbindir)s/sendmail', '%(datadir)s/squirrelmail/index.php')

Specifies that conary should require the file %(sbindir)s/sendmail to be present when trying to install %(datadir)s/squirrelmail/index.php.

r.Requires('soname: %(libdir)/kde3/kgreet_classic.so', '%(bindir)/kdm')

Demonstrates using r.Requires to specify a manual soname requirement of the file %(bindir)s/kdm to the soname %(libdir)/kde3/kgreet_classic.so.

r.Requires(exceptions='/usr/share/vim/.*/doc/')

   C{I{ClassName}(I{info}, I{filterexp})}

   C{I{ClassName}(I{info}, exceptions=I{filterexp})}