[PATCH] D66305: [docs] Convert remaining command guide entries from md to rst.

James Henderson via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Fri Aug 16 03:43:02 PDT 2019


jhenderson added inline comments.


================
Comment at: llvm/docs/CommandGuide/llvm-addr2line.rst:3
+====================================================
+
+SYNOPSIS
----------------
Please add `.. program:: llvm-addr2line` etc to the tops of these files.


================
Comment at: llvm/docs/CommandGuide/llvm-addr2line.rst:7
+
+**llvm-addr2line** [*options*]
+
----------------
Here and elsewhere, use `:program:'llvm-addr2line'` (using backticks instead of apostrophe) etc to match llvm-readelf, llvm-symbolizer etc.


================
Comment at: llvm/docs/CommandGuide/llvm-addr2line.rst:12
+
+**llvm-addr2line** is an alias for the :doc:`llvm-symbolizer <llvm-symbolizer>`
+tool with different defaults. The goal is to make it a drop-in replacement for
----------------
Does using the `:manpage:` link make more sense for the link here, since you use it in the "See Also" block below?


================
Comment at: llvm/docs/CommandGuide/llvm-addr2line.rst:26
+
+-  Uses `–output-style=GNU`_ by default.
+
----------------
--output-style


================
Comment at: llvm/docs/CommandGuide/llvm-size.rst:1
+llvm-size - print segment sizes
+===============================
----------------
"print segment sizes" is factually wrong. llvm-size doesn't look at program headers at all. Perhaps "print size information".


================
Comment at: llvm/docs/CommandGuide/llvm-size.rst:12
+
+**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**.
----------------
Ditto


================
Comment at: llvm/docs/CommandGuide/llvm-strings.rst:12
+
+**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**.
----------------
llvm-strings actually prints strings in all files, not just object files.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D66305/new/

https://reviews.llvm.org/D66305





More information about the llvm-commits mailing list