summaryrefslogtreecommitdiffstats
path: root/python/macholib/doc/macho_o.rst
diff options
context:
space:
mode:
Diffstat (limited to 'python/macholib/doc/macho_o.rst')
-rw-r--r--python/macholib/doc/macho_o.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/python/macholib/doc/macho_o.rst b/python/macholib/doc/macho_o.rst
new file mode 100644
index 000000000..dfa347e8f
--- /dev/null
+++ b/python/macholib/doc/macho_o.rst
@@ -0,0 +1,13 @@
+:mod:`macholib.mach_o` --- Low-level definitions
+================================================
+
+.. module:: macholib.mach_o
+ :synopsis: Low-level definitions of elements in a Mach-O file
+
+This module defines constants and packable structure types
+that correspond to elements of a Mach-O file.
+
+The names of classes and constants is the same as those in
+the Mach-O header files and
+`Apple's documentation <http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/MachORuntime/Reference/reference.html>`_. This document therefore
+doesn't explictly document the names in this module.