[llvm] r363100 - [docs] Add "GNU binutils Replacements" section to command guide

Tue Jun 11 14:13:02 PDT 2019

Author: rupprecht
Date: Tue Jun 11 14:13:01 2019
New Revision: 363100

URL: http://llvm.org/viewvc/llvm-project?rev=363100&view=rev
Log:
[docs] Add "GNU binutils Replacements" section to command guide

Summary:
This splits out a section in the command guide for llvm tools that can be used as replacements for GNU tools. For pages that didn't exist, I added stub pages that can be individually filled in by followup patches.

Tested by running `ninja docs-llvm-html` and inspecting locally.

Reviewers: jhenderson, MaskRay, grimar, alexshap

Reviewed By: jhenderson, MaskRay, grimar

Subscribers: smeenai, arphaman, llvm-commits

Tags: #llvm

Differential Revision: https://reviews.llvm.org/D63014

Added:
    llvm/trunk/docs/CommandGuide/llvm-cxxfilt.md
    llvm/trunk/docs/CommandGuide/llvm-objcopy.md
    llvm/trunk/docs/CommandGuide/llvm-ranlib.md
    llvm/trunk/docs/CommandGuide/llvm-readelf.md
    llvm/trunk/docs/CommandGuide/llvm-size.md
    llvm/trunk/docs/CommandGuide/llvm-strings.md
    llvm/trunk/docs/CommandGuide/llvm-strip.md
Modified:
    llvm/trunk/docs/CommandGuide/index.rst

Modified: llvm/trunk/docs/CommandGuide/index.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/index.rst?rev=363100&r1=363099&r2=363100&view=diff
==============================================================================

--- llvm/trunk/docs/CommandGuide/index.rst (original)
+++ llvm/trunk/docs/CommandGuide/index.rst Tue Jun 11 14:13:01 2019
@@ -20,11 +20,8 @@ Basic Commands
    llc
    lli
    llvm-link
-   llvm-ar
    llvm-lib
    llvm-lipo
-   llvm-nm
-   llvm-objdump
    llvm-config
    llvm-cxxmap
    llvm-diff
@@ -32,12 +29,29 @@ Basic Commands
    llvm-profdata
    llvm-stress
    llvm-symbolizer
-   llvm-addr2line
    llvm-dwarfdump
    dsymutil
    llvm-mca
    llvm-readobj
 
+GNU binutils replacements
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 1
+
+   llvm-addr2line
+   llvm-ar
+   llvm-cxxfilt
+   llvm-nm
+   llvm-objcopy
+   llvm-objdump
+   llvm-ranlib
+   llvm-readelf
+   llvm-size
+   llvm-strings
+   llvm-strip
+
 Debugging Tools
 ~~~~~~~~~~~~~~~
 

Added: llvm/trunk/docs/CommandGuide/llvm-cxxfilt.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cxxfilt.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cxxfilt.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-cxxfilt.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,10 @@
+# llvm-cxxfilt - a symbol demangler
+
+## SYNOPSIS
+
+**llvm-cxxfilt** [*options*]
+
+## DESCRIPTION
+
+**llvm-cxxfilt** is symbol demangler that can be used as a replacement for the
+GNU **c++filt** tool.

Added: llvm/trunk/docs/CommandGuide/llvm-objcopy.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-objcopy.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-objcopy.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-objcopy.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,16 @@
+# llvm-objcopy - object copying tool
+
+## SYNOPSIS
+
+**llvm-objcopy** [*options*]
+
+## DESCRIPTION
+
+**llvm-objcopy** is a tool to copy and manipulate objects.
+
+The tool is still in active development, but in most scenarios it works as a
+drop-in replacement for GNU's **objcopy**.
+
+## SEE ALSO
+
+[llvm-strip](llvm-strip.html)

Added: llvm/trunk/docs/CommandGuide/llvm-ranlib.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-ranlib.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-ranlib.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-ranlib.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,17 @@
+# llvm-ranlib - generates an archive index
+
+## SYNOPSIS
+
+**llvm-ranlib** [*options*]
+
+## DESCRIPTION
+
+**llvm-ranlib** is an alias for the [llvm-ar](llvm-ar.html) tool that generates
+an index for an archive. It can be used as a replacement for GNU's **ranlib**
+tool.
+
+Running **llvm-ranlib** is equivalent to running **llvm-ar s**.
+
+## SEE ALSO
+
+Refer to [llvm-ar](llvm-ar.html) for additional information.

Added: llvm/trunk/docs/CommandGuide/llvm-readelf.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-readelf.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-readelf.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-readelf.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,28 @@
+# llvm-readelf - a drop-in replacement for readelf
+
+## SYNOPSIS
+
+**llvm-readelf** [*options*]
+
+## DESCRIPTION
+
+**llvm-readelf** is an alias for the [llvm-readobj](llvm-readobj.html) tool with
+a command-line interface and output style more closely resembling GNU
+**readelf**.
+
+Here are some of those differences:
+
+* Uses `--elf-output-style=GNU` by default.
+
+* Allows single-letter grouped flags (e.g. `llvm-readelf -SW` is the same as
+  `llvm-readelf -S -W`).
+
+* Allows use of `-s` as an alias for `--symbols` (versus `--section-headers` in
+  **llvm-readobj**) for GNU **readelf** compatibility.
+
+* Prevents use of `-sr`, `-sd`, `-st` and `-dt` **llvm-readobj** aliases, to
+  avoid conflicting with standard GNU **readelf** grouped flags.
+
+## SEE ALSO
+
+Refer to [llvm-readobj](llvm-readobj.html) for additional information.

Added: llvm/trunk/docs/CommandGuide/llvm-size.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-size.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-size.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-size.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,10 @@
+# llvm-size - print segment sizes
+
+## SYNOPSIS
+
+**llvm-size** [*options*]
+
+## DESCRIPTION
+
+**llvm-size** is a tool that prints segment sizes in object files. The goal is
+to make it a drop-in replacement for GNU's **size**.

Added: llvm/trunk/docs/CommandGuide/llvm-strings.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-strings.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-strings.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-strings.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,10 @@
+# llvm-strings - print strings
+
+## SYNOPSIS
+
+**llvm-strings** [*options*]
+
+## DESCRIPTION
+
+**llvm-strings** is a tool that prints strings in object files. The goal is to
+make it a drop-in replacement for GNU's **size**.

Added: llvm/trunk/docs/CommandGuide/llvm-strip.md
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-strip.md?rev=363100&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-strip.md (added)
+++ llvm/trunk/docs/CommandGuide/llvm-strip.md Tue Jun 11 14:13:01 2019
@@ -0,0 +1,16 @@
+# llvm-strip - object stripping tool
+
+## SYNOPSIS
+
+**llvm-strip** [*options*]
+
+## DESCRIPTION
+
+**llvm-strip** is a tool to strip sections and symbols from object files.
+
+The tool is still in active development, but in most scenarios it works as a
+drop-in replacement for GNU's **strip**.
+
+## SEE ALSO
+
+[llvm-objcopy](llvm-objcopy.html)


