[Lldb-commits] [PATCH] D121935: added intel-pt build instructions for lldb

[walter erquinigo via Phabricator via lldb-commits]

wallace requested changes to this revision.
wallace added a comment.
This revision now requires changes to proceed.

Pretty nice improvement! Now you need to reference this doc from the main page. See this reference patch https://reviews.llvm.org/D82064. According to it, you need to move this doc to `lldb/docs/use/intel_pt.rst` and reference it from `lldb/docs/index.rst`.

Besides that, you should generate the documentation and make sure that the output html looks correct. I haven't done that myself, but according to https://reviews.llvm.org/D55376, you should be able to do `ninja docs-lldb-html` after setting as true the cmake flag -DLLVM_ENABLE_SPHINX. Then, include a screenshot of the generated documentation.



================
Comment at: lldb/docs/intel_pt.rst:17
+
+Check for the existance of this particular file on your Linux system
+:: 
----------------



================
Comment at: lldb/docs/intel_pt.rst:48
+
+If this step goes correctly, you should see no errors and **no warnings for unused variables.**
+:: 
----------------
just remove this, as it's a little bit obvious


================
Comment at: lldb/docs/intel_pt.rst:51
+
+  $ cd lldb-build 
+  $ ninja lldb lldb-server # if using Ninja
----------------
let's put this as a one liner as it's common to everyone


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D121935