llvm-capstone/lldb
Raphael Isemann a58aceffad [lldb][docs] Use 'any' as the default role in LLDB's sphinx project
sphinx processes text in backticks depending on what 'role' it has (e.g.,
`:code:\`blub\`` -> role is `code`). If no role is provided, the default role is
taken which is right now using the default value of `content`. `content` only
really makes the text cursive which isn't really useful for anything right now.

Sphinx recommends using the `any` role by default [1] as that turns text in
backticks without an explicit roles into some kind of smart reference. If we did
this in LLDB, then we could just reference SB API classes by doing `\`SBValue\``
instead of typing out the rather verbose `:py:class:`/`:py:func:`/... role
before each reference. This would be especially nice when writing the SB API
docs itself as we constantly have to reference other classes.

[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-any

Reviewed By: JDevlieghere

Differential Revision: https://reviews.llvm.org/D94899
2021-01-18 19:08:19 +01:00
..
bindings [lldb][docs] Use inline literals for code/paths instead of rendering it with the default role 2021-01-18 11:10:19 +01:00
cmake [lldb] Bump the required SWIG version to 3 2021-01-08 08:47:21 -08:00
docs [lldb][docs] Use 'any' as the default role in LLDB's sphinx project 2021-01-18 19:08:19 +01:00
examples [lldb] Remove LLDB session dir and just store test traces in the respective test build directory 2020-12-04 11:43:10 +01:00
include/lldb [lldb] Make DoReadMemory a protected method. 2021-01-07 21:06:36 -08:00
packages/Python Makefile.rules: Make HOST_OS/OS simply expanded variable to avoid excess uname -s invocations 2021-01-17 17:19:29 -08:00
resources [lldb] Remove stale LLDB-Info.plist 2021-01-08 10:12:16 -08:00
scripts [lldb][AArch64/Linux] Show memory tagged memory regions 2020-11-20 11:21:59 +00:00
source DynamicRegisterInfo calculate offsets in separate function 2021-01-15 16:21:18 +05:00
test [lldb] Skip TestPlatformProcessConnect on windows and darwin 2021-01-17 20:18:55 +01:00
third_party/Python/module
tools [debugserver] Fix inverted if block that resulted in us using the private entitlements 2021-01-15 17:41:07 -08:00
unittests [LLDB] MinidumpParser: Prefer executable module even at higher address 2021-01-14 13:17:57 -05:00
utils [lldb] Remove LLDB session dir and just store test traces in the respective test build directory 2020-12-04 11:43:10 +01:00
.clang-format
.clang-tidy
.gitignore
CMakeLists.txt
CODE_OWNERS.txt
LICENSE.TXT
use_lldb_suite_root.py