diff options
Diffstat (limited to 'docs/build/html/_sources/intro.txt')
| -rw-r--r-- | docs/build/html/_sources/intro.txt | 64 |
1 files changed, 29 insertions, 35 deletions
diff --git a/docs/build/html/_sources/intro.txt b/docs/build/html/_sources/intro.txt index 82278ac..400a668 100644 --- a/docs/build/html/_sources/intro.txt +++ b/docs/build/html/_sources/intro.txt @@ -4,11 +4,10 @@ Introduction Overview =================================== -Auto dependency builder is a tool for analysis files accessed during -building a package. It also can be used for buildtime and runtime dependency -analysis. +Auto dependency (autodep) builder is a tool for the analysis of accessed files during +the build of a package. It also can be used for runtime dependencies analysis. -The tool can block an access to files of defined packages. +The tool can trace, log and block access to files of given packages. It is released under GNU GPL license. @@ -32,35 +31,31 @@ Running .. cmdoption:: --help, -h - show this help message and exit + Show this help message and exit. .. cmdoption:: -b, --block - strict mode: deny all access to non-dependency packages + strict mode: Deny all access to files from non-dependency packages. .. cmdoption:: --blockpkgs=PACKAGES - block an access to files from this packages + Block access to files from this packages. -.. cmdoption:: -f , --files +.. cmdoption:: -f, --files - show accessed files and not founded files + Show all files, accessed and missing (not found). +.. cmdoption:: -v, --verbose -.. cmdoption:: -v , --verbose - - show non-important packages, show unknown package and unknown stage - -.. cmdoption:: -C , --nocolor - - don't output color + Show non-important packages, unknown packages and unknown building stages. +.. cmdoption:: --nocolor, -C + Don't colorize output .. cmdoption:: --hooklib - use ld_preload logging approach(default) - + Use LD_PRELOAD logging approach (default). .. cmdoption:: --fusefs - use fuse logging approach(slow, but reliable) + Use FUSE logging approach (slow, but reliable). Example: showfsevents.py -b lsof,cowsay emerge bash @@ -68,56 +63,55 @@ Hooklib vs Fusefs =================================== +------------------------------------------------+-------------+---------------+ -| | Hooklib | Fusefs | +| | Hooklib | FuseFS | +================================================+=============+===============+ | Who can use this approach? | **Any user**| Only root | +------------------------------------------------+-------------+---------------+ -| Is approach allows blocking an access to files?| **YES** | **YES** | +| Does approach allows to block access to files? | **YES** | **YES** | +------------------------------------------------+-------------+---------------+ -| Is overhead in performance big? | **NO** | YES [#f1]_ | +| Is the overhead in performance noticeable? | **NO** | YES [#f1]_ | +------------------------------------------------+-------------+---------------+ | What events are logged? | Most [#f2]_| **ALL** | +------------------------------------------------+-------------+---------------+ -| When is it recomended to use an approach? | For analysis| For analysis | +| When is it recomended to use an approach? | Analysis | Analysis | | | of | of *runtime* | | | *buildtime* | dependencies | | | dependencies| | +------------------------------------------------+-------------+---------------+ -| Is any pre-requirements for using an approach? | **NO** | FUSE must be | -| | | enabled in | +| Are there any pre-requirements | **NO** | FUSE must be | +| for using an approach? | | enabled in | | | | kernel | +------------------------------------------------+-------------+---------------+ .. rubric:: Notes -.. [#f1] Fuse file system is slower than normal one. Program reads many files +.. [#f1] FUSE filesystems are slower than a normal one. A Program accesses many files while launching, so this will take more time than usual. -.. [#f2] Loading of dynamic libraries and direct syscalls will not be logged. +.. [#f2] Loading of Dynamic libraries and direct syscalls will not be logged. Examples =================================== -.. rubric:: 1. Get the potential dependencies of a xchat package: +.. rubric:: 1. Get the potential dependencies for net-irc/xchat: .. code-block:: none - autodep emerge xchat + autodep emerge net-irc/xchat -.. rubric:: 2. Get the potential dependencies of a xchat package, blocking +.. rubric:: 2. Get the potential dependencies for net-irc/xchat, blocking x11-misc/util-macros package: .. code-block:: none - autodep emerge --block x11-misc/util-macros emerge xchat + autodep emerge --blockpkgs x11-misc/util-macros emerge net-irc/xchat -.. rubric:: 3. Get the potential dependencies of a xchat package, and show files +.. rubric:: 3. Get the potential dependencies for net-irc/xchat, and show files accessed: .. code-block:: none - autodep --files emerge xchat + autodep --files emerge net-irc/xchat -.. rubric:: 4. Get the runtime dependencies of a xchat and show files - accessed: +.. rubric:: 4. Get the runtime dependencies of a xchat and show accessed files: .. code-block:: none |