From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- python/macholib/doc/framework.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 python/macholib/doc/framework.rst (limited to 'python/macholib/doc/framework.rst') diff --git a/python/macholib/doc/framework.rst b/python/macholib/doc/framework.rst new file mode 100644 index 000000000..b58b5751c --- /dev/null +++ b/python/macholib/doc/framework.rst @@ -0,0 +1,34 @@ +:mod:`macholib.framework` --- Generic framework path manipulation +========================================================================== + +.. module:: macholib.framework + :synopsis: Generic framework path manipulation + + +This module defines a function :func:`framework_info` that can extract +useful information from the name of a dynamic library in a framework. + +.. function:: framework_info(filename) + + A framework name can take one of the following four forms: + + * ``Location/Name.framework/Versions/SomeVersion/Name_Suffix`` + + * ``Location/Name.framework/Versions/SomeVersion/Name`` + + * ``Location/Name.framework/Name_Suffix`` + + * ``Location/Name.framework/Name`` + + Returns ``None`` if not found, or a mapping equivalent to:: + + dict( + location='Location', + name='Name.framework/Versions/SomeVersion/Name_Suffix', + shortname='Name', + version='SomeVersion', + suffix='Suffix', + ) + + .. note:: *SomeVersion* and *Suffix* are optional and may be None + if not present. -- cgit v1.2.3