diff options
| author | Renato Golin <renato.golin@linaro.org> | 2016-07-20 12:16:38 +0000 |
|---|---|---|
| committer | Renato Golin <renato.golin@linaro.org> | 2016-07-20 12:16:38 +0000 |
| commit | 124f2593fce8b867d3c8dee17bfd3e009b06b67e (patch) | |
| tree | 0960cac9f55a3f1178ddd55faa1d674306e30b21 /llvm/docs/WritingAnLLVMPass.rst | |
| parent | 5b7a79f92a656cf7f9f814283de097b01f4b4a56 (diff) | |
| download | bcm5719-llvm-124f2593fce8b867d3c8dee17bfd3e009b06b67e.tar.gz bcm5719-llvm-124f2593fce8b867d3c8dee17bfd3e009b06b67e.zip | |
[docs] Fixing Sphinx warnings to unclog the buildbot
Lots of blocks had "llvm" or "nasm" syntax types but either weren't following
the syntax, or the syntax has changed (and sphinx hasn't keep up) or the type
doesn't even exist (nasm?).
Other documents had :options: what were invalid. I only removed those that had
warnings, and left the ones that didn't, in order to follow the principle of
least surprise.
This is like this for ages, but the buildbot is now failing on errors. It may
take a while to upgrade the buildbot's sphinx, if that's even possible, but
that shouldn't stop us from getting docs updates (which seem down for quite
a while).
Also, we're not losing any syntax highlight, since when it doesn't parse, it
doesn't colour. Ie. those blocks are not being highlighted anyway.
I'm trying to get all docs in one go, so that it's easy to revert later if we
do fix, or at least easy to know what's to fix.
llvm-svn: 276109
Diffstat (limited to 'llvm/docs/WritingAnLLVMPass.rst')
| -rw-r--r-- | llvm/docs/WritingAnLLVMPass.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/llvm/docs/WritingAnLLVMPass.rst b/llvm/docs/WritingAnLLVMPass.rst index 9e9d9f1703a..537bbbc19d2 100644 --- a/llvm/docs/WritingAnLLVMPass.rst +++ b/llvm/docs/WritingAnLLVMPass.rst @@ -747,7 +747,7 @@ template parameter is the name of the pass that is to be used on the command line to specify that the pass should be added to a program (for example, with :program:`opt` or :program:`bugpoint`). The first argument is the name of the pass, which is to be used for the :option:`-help` output of programs, as well -as for debug output generated by the :option:`--debug-pass` option. +as for debug output generated by the `--debug-pass` option. If you want your pass to be easily dumpable, you should implement the virtual print method: |
