[llvm-lipo] Add docs for llvm-lipo
authorAlexander Shaposhnikov <shal1t712@gmail.com>
Fri, 7 Jun 2019 22:03:02 +0000 (22:03 +0000)
committerAlexander Shaposhnikov <shal1t712@gmail.com>
Fri, 7 Jun 2019 22:03:02 +0000 (22:03 +0000)
Add docs (llvm-lipo.rst) for llvm-lipo.

Test plan:
make -j8 sphinx
check that ./docs/html/CommandGuide/llvm-lipo.html is built correctly and looks okay.

Differential revision: https://reviews.llvm.org/D62706

llvm-svn: 362848

llvm/docs/CommandGuide/index.rst
llvm/docs/CommandGuide/llvm-lipo.rst [new file with mode: 0644]

index 650ff07..b461757 100644 (file)
@@ -22,6 +22,7 @@ Basic Commands
    llvm-link
    llvm-ar
    llvm-lib
+   llvm-lipo
    llvm-nm
    llvm-objdump
    llvm-config
diff --git a/llvm/docs/CommandGuide/llvm-lipo.rst b/llvm/docs/CommandGuide/llvm-lipo.rst
new file mode 100644 (file)
index 0000000..5ef7bcc
--- /dev/null
@@ -0,0 +1,33 @@
+llvm-lipo - LLVM tool for manipulating universal binaries
+=========================================================
+
+SYNOPSIS
+--------
+
+:program:`llvm-lipo` [*filenames...*] [*options*]
+
+DESCRIPTION
+-----------
+:program:`llvm-lipo` can create universal binaries from Mach-O files, extract regular object files from universal binaries, and display architecture information about both universal and regular files.
+
+COMMANDS
+--------
+:program:`llvm-lipo` supports the following mutually exclusive commands:
+
+.. option:: -help, -h
+
+  Display usage information and exit. 
+
+.. option:: -version
+
+  Display the version of this program. 
+
+.. option:: -verify_arch  <architecture 1> [<architecture 2> ...]
+
+  Take a single input file and verify the specified architectures are present in the file. 
+  If so then exit with a status of 0 else exit with a status of 1.
+
+BUGS
+----
+
+To report bugs, please visit <http://llvm.org/bugs/>.