summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandGuide
Commit message (Collapse)AuthorAgeFilesLines
* [tools] [llvm-nm] Default to reading from stdin not a.outAlex Brachet2019-07-121-3/+2
| | | | | | | | | | | | | | | | Summary: This moves away from defaulting to a.out and uses stdin only if stdin has a file redirected to it. This has been discussed on the llvm-dev mailing list [[ https://lists.llvm.org/pipermail/llvm-dev/2019-July/133642.html | here ]]. Reviewers: jhenderson, rupprecht, MaskRay, chrisjackson Reviewed By: jhenderson, MaskRay Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D64290 llvm-svn: 365889
* [docs][llvm-symbolizer] Fix grammarJames Henderson2019-07-101-1/+1
| | | | llvm-svn: 365630
* [docs][llvm-dwarfdump] Normalise some wordingJames Henderson2019-07-101-1/+1
| | | | llvm-svn: 365603
* [docs][llvm-dwarfdump] Fix wordingJames Henderson2019-07-091-1/+1
| | | | llvm-svn: 365489
* [docs][llvm-objdump] Make some wording improvements/simplifications.James Henderson2019-07-091-13/+9
| | | | llvm-svn: 365474
* [docs][llvm-nm] Improve some wordingJames Henderson2019-07-091-15/+13
| | | | | | | In particular, the --debug-syms switch really doesn't have anything to do with debuggers, so I've updated the document accordingly. llvm-svn: 365461
* [docs][llvm-dwarfdump] Make some option descriptions clearer and more preciseJames Henderson2019-07-091-12/+10
| | | | | | | | | | | | Some of the wording in the doc (taken largely from the help text), was a little imprecise in some cases, so this patch makes it a little more precise. Reviewed by: JDevlieghere, probinson Differential Revision: https://reviews.llvm.org/D64332 llvm-svn: 365451
* [docs][llvm-readobj][llvm-readelf] Improve wordingJames Henderson2019-07-082-4/+4
| | | | llvm-svn: 365335
* [lit] Parse command-line options from LIT_OPTSJoel E. Denny2019-07-081-0/+5
| | | | | | | | | | | | | | | | | Similar to `FILECHECK_OPTS` for FileCheck, `LIT_OPTS` makes it easy to adjust lit behavior when running the test suite via ninja. For example: ``` $ LIT_OPTS='--time-tests -vv --filter=threadprivate' \ ninja check-clang-openmp ``` Reviewed By: probinson Differential Revision: https://reviews.llvm.org/D64135 llvm-svn: 365313
* [docs][llvm-objcopy] Add description of binary input/output to docJames Henderson2019-07-081-2/+17
| | | | | | | | | | | | We briefly referred to being able to specify --target=binary without explaining what binary input/output meant. This change adds a section on this. Reviewed by: MaskRay, abrachet Differential Revision: https://reviews.llvm.org/D64245 llvm-svn: 365312
* [docs][llvm-readobj] Add a note to options that do nothing in GNU outputJames Henderson2019-07-052-4/+10
| | | | | | | | | | --section-data, --section-relocations and --section-symbols have no effect for GNU style ouput. This patch changes the docs to point this out, as it has caught me out on a couple of occasions. See also https://bugs.llvm.org/show_bug.cgi?id=42522. llvm-svn: 365221
* [docs][llvm-objcopy] Improve some wording.James Henderson2019-07-051-4/+4
| | | | llvm-svn: 365187
* [docs] [tools] Fix see also linksAlex Brachet2019-07-047-7/+7
| | | | | | | | | | | | | | | | Summary: Changes "see also" links to use :manpage: instead of plain text or the form `name|name` which was being treated literally, not as a link. Reviewers: jhenderson, rupprecht Reviewed By: jhenderson Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63970 llvm-svn: 365159
* [docs][llvm-dwarfdump] Remove unnecessary reference to --show-childrenJames Henderson2019-07-041-3/+1
| | | | | | | | | | | | | The --show-children option description describes what it does, and references the =<offset> parameter of section dump switches. I don't think it needs to be explained again in the documentation of the section dump switches too. Reviewed by: JDevlieghere Differential Revision: https://reviews.llvm.org/D64132 llvm-svn: 365115
* [docs] [NFC] Removed excess spacingAlex Brachet2019-07-0417-189/+0
| | | | | | | | | | | | | | | | Summary: Removed excess new lines from documentations. As far as I can tell, it seems as though restructured text is agnostic to new lines, the use of new lines was inconsistent and had no effect on how the files were being displayed. Reviewers: jhenderson, rupprecht, JDevlieghere Reviewed By: jhenderson Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63971 llvm-svn: 365105
* [docs][llvm-objcopy] Write documentation for llvm-objcopyJames Henderson2019-07-032-16/+482
| | | | | | | | | | | | This patch addresses https://bugs.llvm.org/show_bug.cgi?id=42183 by replacing the stub markdown doc for llvm-objcopy with a full one describing the current options available in llvm-objcopy. Reviewed by: jakehehrlich, MaskRay Differential Revision: https://reviews.llvm.org/D63820 llvm-svn: 365042
* [docs][llvm-readelf] Delete old llvm-readelf.mdJames Henderson2019-07-021-28/+0
| | | | | | This was accidentally missed when committing r364800. llvm-svn: 364918
* [docs][llvm-readelf] Expand llvm-readelf documentationJames Henderson2019-07-012-0/+218
| | | | | | | | | | | | | | | | | | Previously, the llvm-readelf documentation was essentially just a list of differences to llvm-readobj. Since llvm-readelf is the more likely goto tool for many people migrating to the LLVM toolchain, it seems like it would be helpful to document all the switches in the llvm-readelf document too. This change expands the options listed accordingly. Additionally, they are unlikely to care what the differences are to llvm-readobj, since they won't be familiar with the latter as there is no GNU equivalent, so this change moves the "differences" section to llvm-readobj's documentation. Reviewed by: peter.smith Differential Revision: https://reviews.llvm.org/D63826 llvm-svn: 364800
* [llvm-objdump] Update the doc for --disassemble-functions.Yuanfang Chen2019-06-271-4/+6
| | | | | | | | | | | | | | Update the doc after llvm-svn: 364121 is landed. With two more trivial fixes that are not related to --disassemble-functions but still about llvm-objdump. Reviewers: jhenderson, grimar, MaskRay, rupprecht, peter.smith Reviewed by: jhenderson, MaskRay Differential Revision: https://reviews.llvm.org/D63787 llvm-svn: 364573
* [docs][llvm-nm][llvm-objdump] Improve "See Also" sectionJames Henderson2019-06-272-2/+3
| | | | | | | | | | | | | The "See Also" section for llvm-nm didn't actually contain any links, and the tools referred to didn't make much sense (referring to non-LLVM tools, when we have equivalents, or tools that aren't really to do with symbol dumping). llvm-objdump's didn't refer to llvm-readelf. Reviewed by: grimar Differential Revision: https://reviews.llvm.org/D63875 llvm-svn: 364552
* [docs][tools] Add missing "program" tags to rst filesJames Henderson2019-06-2732-0/+68
| | | | | | | | | | | | | | | | | | | | | | Sphinx allows for definitions of command-line options using `.. option <name>` and references to those options via `:option:<name>`. However, it looks like there is no scoping of these options by default, meaning that links can end up pointing to incorrect documents. See for example the llvm-mca document, which contains references to -o that, prior to this patch, pointed to a different document. What's worse is that these links appear to be non-deterministic in which one is picked (on my machine, some references end up pointing to opt, whereas on the live docs, they point to llvm-dwarfdump, for example). The fix is to add the .. program <name> tag. This essentially namespaces the options (definitions and references) to the named program, ensuring that the links are kept correct. Reviwed by: andreadb Differential Revision: https://reviews.llvm.org/D63873 llvm-svn: 364538
* [docs][llvm-symbolizer] Improve llvm-symbolizer documentationJames Henderson2019-06-261-99/+271
| | | | | | | | | | | | | | | | | | | | | | | | | As detailed in https://bugs.llvm.org/show_bug.cgi?id=42253, there were a number of issues in the llvm-symbolizer documentation. This patch fixes them by: 1. Adding [addresses...] to the synopsis, and matching the formatting of other tools. 2. Rewriting the description to fix grammar issues and mention other usage options. 3. Rewriting the examples to be easier to read. 4. Re-ordering the options into alphabetical order. 5. Improving the text of some of the option descriptions, and adding some examples to individual options. 6. Splitting the Mach-O options into a separate section of the document. 7. Standardizing on double dashes for long options throughout the file. 8. Adding a reference to the llvm-addr2line document. Reviewed by: mtrent, ikudrin Differential Revision: https://reviews.llvm.org/D63651 llvm-svn: 364410
* [docs][llvm-readobj] Improve llvm-readobj documentationJames Henderson2019-06-251-39/+220
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There were a number of issues with the llvm-readobj documentation. The following points were raised in https://bugs.llvm.org/show_bug.cgi?id=42255, and have been fixed in this patch: 1. The description section claimed "The tool and its output is primarily designed for use in FileCheck-based tests" which is not really the case any more. 2. The documentation used single-dash long options for option names, but references in the help text to other options exclusively used double-dashes. Fixed by standardising on double-dashes for all long-form options. 3. The majority of options available and in the help text were not present in the documentation. This patch adds them. 4. Several aliases, both long and short, were missing, e.g. --relocs. Additionally, this patch improves the documentation by: 1. Splitting the options into categories based on the file format they are specific to. 2. Updating the Exit Status section to correctly mention that errors lead to a non-zero exit code. 3. Adding a See Also section referencing other similar LLVM tools. 4. Improving/correcting some of the descriptions of options that did not quite match up with what llvm-readobj does. Reviewed by: peter.smith, MaskRay, mtrent Differential Revision: https://reviews.llvm.org/D63719 llvm-svn: 364306
* [docs][llvm-cxxfilt] Write llvm-cxxfilt documentationJames Henderson2019-06-252-10/+79
| | | | | | | | | | | | | There was a stub for llvm-cxxfilt, but it didn't describe the options. Additionally, it was in markdown, which was causing issues, so as discussed in https://reviews.llvm.org/D63211, this change replaces the existing stub with an RST file. Reviewed by: MaskRay, mattd Differential Revision: https://reviews.llvm.org/D63722 llvm-svn: 364287
* [docs][llvm-nm] Add missing options to documentationJames Henderson2019-06-241-21/+91
| | | | | | | | | | | | | | There were several options missing from the documentation. This patch adds them as well as improving some wording and separating the Mach-O only options into a separate section. Fixes https://bugs.llvm.org/show_bug.cgi?id=42234. Reviewed by: MaskRay Differential Revision: https://reviews.llvm.org/D63655 llvm-svn: 364176
* [docs][llvm-nm] Improve symbol code documentationJames Henderson2019-06-241-15/+70
| | | | | | | | | | | | | | The existing symbol code documentation was very incomplete. This patch adds the missing codes, and defines them based on the current code behaviour. Fixes https://bugs.llvm.org/show_bug.cgi?id=42231. Reviewed by: rupprecht, mtrent, MaskRay Differential Revision: https://reviews.llvm.org/D63327 llvm-svn: 364171
* [docs][llvm-objdump] Fix bad merge of docsJames Henderson2019-06-211-4/+4
| | | | llvm-svn: 364056
* [binutils] Add response file option to help and docsJames Henderson2019-06-214-0/+16
| | | | | | | | | | | | | | | | | | | | | Many LLVM-based tools already support response files (i.e. files containing a list of options, specified with '@'). This change simply updates the documentation and help text for some of these tools to include it. I haven't attempted to fix all tools, just a selection that I am interested in. I've taken the opportunity to add some tests for --help behaviour, where they were missing. We could expand these tests, but I don't think that's within scope of this patch. This fixes https://bugs.llvm.org/show_bug.cgi?id=42233 and https://bugs.llvm.org/show_bug.cgi?id=42236. Reviewed by: grimar, MaskRay, jkorous Differential Revision: https://reviews.llvm.org/D63597 llvm-svn: 364036
* [docs][llvm-objdump] Improve llvm-objdump documentationJames Henderson2019-06-211-36/+240
| | | | | | | | | | | | | | | | | | The llvm-objdump document was missing many options, and there were also some style issues with it. This patches fixes all but the first issue listed in https://bugs.llvm.org/show_bug.cgi?id=42249 by: 1. Adding missing options and commands. 2. Standardising on double dashes for long-options throughout. 3. Moving Mach-O specific options to a separate section. 4. Removing options that don't exist or aren't relevant to llvm-objdump. Reviewed by: MaskRay, mtrent, alexshap Differential Revision: https://reviews.llvm.org/D63606 llvm-svn: 364019
* [FileCheck] Stop qualifying expressions as numericThomas Preud'homme2019-06-191-9/+9
| | | | | | | | | | | | | | | | | Summary: Stop referring to "numeric expression", using simply the term "expression" instead. Likewise for numeric operation since operations are only used in numeric expressions. Reviewers: jhenderson, jdenny, probinson, arichardson Subscribers: hiraditya, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63500 llvm-svn: 363901
* [llvm-mca][docs] clarify how the quality of the perf report is affected by ↵Andrea Di Biagio2019-06-191-0/+11
| | | | | | | | the quality of the scheduling models. Differential Revision: https://reviews.llvm.org/D63556 llvm-svn: 363830
* [docs][llvm-dwarfdump] Make the --show-parents and --show-children help text ↵James Henderson2019-06-141-6/+6
| | | | | | | | | | | | | | | | | | and docs more consistent and correct The docs and help text for --show-parents and --show-children were a bit inconsistent. The help text claimed they had an effect when "=<offset>" was used, whereas the doc said it had an effect when "--find" or "--name" were used. This change changes the doc to mention "=<offset>" and removes this reference from the help text, to avoid having a very long description in the help text (it still says "when selectively printing entries"). Reviewed by: JDevlieghere, aprantl Differential Revision: https://reviews.llvm.org/D63275 llvm-svn: 363380
* [Coverage] Load code coverage data from archivesVedant Kumar2019-06-131-0/+6
| | | | | | | | | | | | | Support loading code coverage data from regular archives, thin archives, and from MachO universal binaries which contain archives. Testing: check-llvm, check-profile (with {A,UB}San enabled) rdar://51538999 Differential Revision: https://reviews.llvm.org/D63232 llvm-svn: 363325
* [docs][llvm-symbolizer] Fix formatting issue with --functionsJames Henderson2019-06-131-4/+4
| | | | | | | | Reviewed by: rupprecht Differential Revision: https://reviews.llvm.org/D63195 llvm-svn: 363266
* [docs][llvm-dwarfdump] Add missing options and behaviour to documentationJames Henderson2019-06-131-4/+35
| | | | | | | | | | | | | | This fixes https://bugs.llvm.org/show_bug.cgi?id=42185. llvm-dwarfdump's documentation was missing a number of options and other behaviours. This change tries to fix up the documentation by adding these missing items. Reviewed by: JDevlieghere Differential Revision: https://reviews.llvm.org/D63217 llvm-svn: 363264
* [llvm-lipo] Update llvm-lipo docs for -archs flagShoaib Meenai2019-06-121-0/+6
| | | | | | | | | | The information for -archs flag is added to llvm-lipo.rst. Patch by Anusha Basana <anusha.basana@gmail.com> Differential Revision: https://reviews.llvm.org/D63100 llvm-svn: 363182
* [docs][llvm-symbolizer] Fix typo and grammar errorJames Henderson2019-06-121-2/+3
| | | | llvm-svn: 363145
* [docs] Fix typoJames Henderson2019-06-121-1/+1
| | | | llvm-svn: 363138
* [llvm-nm] Fix docs and help text for --print-sizeJames Henderson2019-06-121-1/+1
| | | | | | | | | | | | The --print-size help text and documentation claimed that the size was printed instead of the address, but this is incorrect. It is printed as well as the address. This patch fixes this issue. Reviewed by: MaskRay, mtrent, ruiu Differential Revision: https://reviews.llvm.org/D63142 llvm-svn: 363136
* [docs] Add "GNU binutils Replacements" section to command guideJordan Rupprecht2019-06-118-4/+125
| | | | | | | | | | | | | | | | | | | 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 llvm-svn: 363100
* [docs][llvm-nm] Add darwin as --format optionJames Henderson2019-06-111-2/+2
| | | | llvm-svn: 363081
* [docs][llvm-nm] Make --help help text consistent with other optionsJames Henderson2019-06-111-1/+1
| | | | llvm-svn: 363073
* [llvm-dwarfdump] Simplify --ignore-case help text and documentationJames Henderson2019-06-111-2/+1
| | | | | | | | | | | | | | | There was a typo in the --ignore-case help text that was copied into the llvm-dwarfdump command-guide. Additionally, this patch simplifies the wording, since it was unnecessarily verbose: the switch applies for searching in general and doesn't need explicitly stating different search modes (which might go out-of-date as options are added or removed). Reviwed by: JDevlieghere Differential Revision: https://reviews.llvm.org/D63133 llvm-svn: 363066
* [docs][llvm-nm] Fix documentation regarding llvm-nm reading stdinJames Henderson2019-06-111-2/+3
| | | | | | | | | | | | llvm-nm reads a.out NOT stdin when no input file is specified. This patch fixes the doc accordingly, and rephrases the surrounding sentence slightly. Reviewed by: grimar Differential Revision: https://reviews.llvm.org/D63135 llvm-svn: 363065
* [llvm-dwarfdump] Add -o to help text and remove --out-file from docJames Henderson2019-06-111-1/+1
| | | | | | | | | | | | | -o is in the documentation, but not in the llvm-dwarfdump help text. This patch adds it by inverting the -o and --out-file aliasing. It also removes --out-file from the documentation, since we don't really want people to be using this switch in practice. Reviewed by: aprantl, JDevlieghere, dblaikie Differential Revision: https://reviews.llvm.org/D63013 llvm-svn: 363044
* [Docs] [llvm-mca] Point out a caveat for using llvm-mca markers in source code.Matt Davis2019-06-101-2/+11
| | | | | | | | | | | | | | | | | | Summary: See: https://bugs.llvm.org/show_bug.cgi?id=42173 Reviewers: andreadb, mattd, RKSimon, spatel Reviewed By: andreadb Subscribers: tschuett, gbedwell, llvm-commits, andreadb Tags: #llvm Patch by Max Marrone (maxpm)! Thanks! Differential Revision: https://reviews.llvm.org/D63040 llvm-svn: 362979
* [llvm-lipo] Add docs for llvm-lipoAlexander Shaposhnikov2019-06-072-0/+34
| | | | | | | | | | | | Add docs (llvm-lipo.rst) for llvm-lipo. Test plan: make -j8 sphinx check that ./docs/html/CommandGuide/llvm-lipo.html is built correctly and looks okay. Differential revision: https://reviews.llvm.org/D62706 llvm-svn: 362848
* [docs]Move llvm-readobj from "Developer Tools" to "Basic Commands"James Henderson2019-06-071-1/+1
| | | | | | | | | | | | | | On the Command Guide page, there are multiple sections with links to the different documentation pages available for LLVM tools. The "Basic Tools" section includes tools like llvm-objdump, llvm-nm and so on. The "Developer Tools" section contains things like FileCheck and lit. This change moves llvm-readobj into the former block, from the latter. Reviewed by: MaskRay Differential Revision: https://reviews.llvm.org/D63011 llvm-svn: 362813
* FileCheck [6/12]: Introduce numeric variable definitionThomas Preud'homme2019-06-061-17/+32
| | | | | | | | | | | | | | | | | | | | | | | | | | Summary: This patch is part of a patch series to add support for FileCheck numeric expressions. This specific patch introduces support for defining numeric variable in a CHECK directive. This commit introduces support for defining numeric variable from a litteral value in the input text. Numeric expressions can then use the variable provided it is on a later line. Copyright: - Linaro (changes up to diff 183612 of revision D55940) - GraphCore (changes in later versions of revision D55940 and in new revision created off D55940) Reviewers: jhenderson, chandlerc, jdenny, probinson, grimar, arichardson, rnk Subscribers: hiraditya, llvm-commits, probinson, dblaikie, grimar, arichardson, tra, rnk, kristina, hfinkel, rogfer01, JonChesterfield Tags: #llvm Differential Revision: https://reviews.llvm.org/D60386 llvm-svn: 362705
* [Docs] Modernize references to macOSJ. Ryan Stinnett2019-05-301-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Summary: This updates all places in documentation that refer to "Mac OS X", "OS X", etc. to instead use the modern name "macOS" when no specific version number is mentioned. If a specific version is mentioned, this attempts to use the OS name at the time of that version: * Mac OS X for 10.0 - 10.7 * OS X for 10.8 - 10.11 * macOS for 10.12 - present Reviewers: JDevlieghere Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits Tags: #clang, #lldb, #libc, #llvm Differential Revision: https://reviews.llvm.org/D62654 llvm-svn: 362113
OpenPOWER on IntegriCloud