summaryrefslogtreecommitdiffstats
path: root/clang/docs/tools
Commit message (Collapse)AuthorAgeFilesLines
* [clang-format] Ensure dump_format_style.py can generate ↵paul_hoad2019-11-081-1/+20
| | | | | | | | | | | | | | | | | | | | | | | | ClangFormatStyleOptions.rst without manual intervention Summary: This revision is the last in a series of revisions to return `clang/doc/tools/dump_format_style.py` to be being able to parse Format.h without needing to manually merge the ClangFormatStyleOptions.rst file. The final modification to dump_format_style.py is needed following the addition of a nested enumeration inside a nested structure following the introduction of {D68296} Prior related revisions will allow for a fully clang-formatted `clang/include/clang/Format/Format.h` to once again be used at the source. {D69951} {D69433} {D69404} Reviewers: mitchell-stellar, klimek, sammccall, owenpan Reviewed By: mitchell-stellar Subscribers: cfe-commits Tags: #clang-format, #clang Differential Revision: https://reviews.llvm.org/D70003
* [clang-format] [NFC] update the documentation in Format.h to allow ↵paulhoad2019-11-061-3/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | dump_format_style.py to get a little closer to being correct. (part 2) Summary: a change {D67541} cause LanguageStandard to now be subtly different from all other clang-format options, in that the Enum value (less the prefix) is not always allowed as valid as the configuration option. This caused the ClangFormatStyleOptions.rst and the Format.h to diverge so that the ClangFormatStyleOptions.rst could no longer be generated from the Format.h using dump_format_stlye.py This fix tried to remedy that: 1) by allowing an additional comment (in Format.h) after the enum to be used as the `in configuration ( XXXX )` text, and changing the dump_format_style.py to support that. This makes the following code: ``` enum { ... LS_Cpp03, // c++03 LS_Cpp11, // c++11 ... }; ``` would render as: ```* ``LS_Cpp03`` (in configuration: ``c++03``) * ``LS_Cpp11`` (in configuration: ``c++11``) ``` And we also move the deprecated alias into the text of the enum (otherwise it won't be added at the end as an option) This patch includes a couple of other whitespace changes which help bring Format.h and ClangFormatStyleOptions.rst almost back into line and regeneratable... (there is still one more) Reviewers: klimek, mitchell-stellar, sammccall Reviewed By: mitchell-stellar, sammccall Subscribers: mrexodia, cfe-commits Tags: #clang, #clang-format Differential Revision: https://reviews.llvm.org/D69433
* Portable Python script across Python versionSerge Guelton2018-12-192-3/+5
| | | | | | | | | urllib2 as been renamed into urllib and the library layout has changed. Workaround that in a consistent manner. Differential Revision: https://reviews.llvm.org/D55199 llvm-svn: 349627
* Portable Python script across Python versionSerge Guelton2018-12-181-4/+4
| | | | | | | | Using from __future__ import print_function it is possible to have a compatible behavior of `print(...)` across Python version. Differential Revision: https://reviews.llvm.org/D55213 llvm-svn: 349454
* Portable Python script across Python versionSerge Guelton2018-12-181-2/+2
| | | | | | | dict no longer have the `has_key` method in Python3. Instead, one can use the `in` keyword which already works in Python2. llvm-svn: 349447
* Stop stripping comments from AST matcher example code.Aaron Ballman2018-12-111-1/+1
| | | | | | The AST matcher documentation dumping script was being a bit over-zealous about stripping comment markers, which ended up causing comments in example code to stop being comments. Fix that by only stripping comments at the start of a line, rather than removing any forward slash (which also impacts prose text). llvm-svn: 348891
* Portable Python script across versionSerge Guelton2018-12-031-6/+6
| | | | | | | | | Have all classes derive from object: that's implicitly the default in Python3, it needs to be done explicilty in Python2. Differential Revision: https://reviews.llvm.org/D55121 llvm-svn: 348127
* Update our URLs in clang doc to use httpsSylvestre Ledru2018-11-041-1/+1
| | | | llvm-svn: 346101
* Remove non-existant typeloc matchers from documentationStephen Kelly2018-10-091-3/+3
| | | | llvm-svn: 344023
* [clang-format ]Extend IncludeCategories regex documentationKrasimir Georgiev2018-07-251-1/+3
| | | | | | | | | | | | | | | | | | | Summary: Extend the Clang-Format IncludeCategories documentation by adding a link to the supported regular expression standard (POSIX). And extenting the example with a system header regex. [[ https://bugs.llvm.org/show_bug.cgi?id=35041 | bug 35041]] Contributed by WimLeflere! Reviewers: krasimir, Typz Reviewed By: krasimir Subscribers: cfe-commits Differential Revision: https://reviews.llvm.org/D48827 llvm-svn: 337899
* [ASTMatchers] Support generating docs for single-line matchersBenjamin Kramer2018-01-171-1/+1
| | | | | | clang-format likes this format. PR35989. llvm-svn: 322783
* Update dump_ast_matchers for many recent changes.Benjamin Kramer2018-01-171-13/+14
| | | | | | | The html file hasn't been updated in a long time so there are quite a few changes in there. No matchers were removed though. llvm-svn: 322687
* [clang-format] Sort using declarations by splitting on '::'Krasimir Georgiev2017-11-091-1/+2
| | | | | | | | | | | | | | Summary: This patch improves using declarations sorting. Reviewers: bkramer Reviewed By: bkramer Subscribers: cfe-commits, klimek Differential Revision: https://reviews.llvm.org/D39786 llvm-svn: 317794
* [clang-format] Update dump_format_style.py to indent nested fieldsKrasimir Georgiev2017-06-231-5/+6
| | | | | | | | | | | | | | | | | | Summary: This updates the format options documentation script to indent the documentation of nested fields. The previous format caused some problems, as when a bulleted list ends with a multiline comment. See the buildbot failure http://lab.llvm.org:8011/builders/clang-sphinx-docs/builds/10020/steps/docs-clang-html/logs/stdio Reviewers: djasper Reviewed By: djasper Subscribers: cfe-commits Differential Revision: https://reviews.llvm.org/D34552 llvm-svn: 306093
* [clang-format] Add more examples and fix a bug in the py generation scriptSylvestre Ledru2017-03-131-1/+1
| | | | | | | | | | | | Reviewers: djasper Reviewed By: djasper Subscribers: cfe-commits, klimek Differential Revision: https://reviews.llvm.org/D30860 llvm-svn: 297623
* Remove a useless subsitution in doxygen2rst which was incorrectly replacing ↵Sylvestre Ledru2017-03-091-1/+0
| | | | | | | | | | | | | | | | * by \* Summary: For example, "int\* a;" is displayed instead of "int* a;" Reviewers: djasper Reviewed By: djasper Subscribers: cfe-commits Differential Revision: https://reviews.llvm.org/D30740 llvm-svn: 297363
* IgnoringImplicit matcher.Cong Liu2016-06-241-0/+0
| | | | llvm-svn: 273659
* Fix the doc extraction script to work with hasAnyName and with equalsNode.Samuel Benzaquen2016-05-041-3/+3
| | | | | | | | | The change from llvm::VariadicFunction to internal::VariadicFunction broke the extraction of hasAnyName(). equalsNode was broken because the argument type is 'const XXXX*' and the internal space caused a failure on the regex. llvm-svn: 268548
* Support language selection for \code blocks.Alexander Kornienko2016-02-231-3/+7
| | | | llvm-svn: 261644
* Allow running dump_format_style.py from any directory.Alexander Kornienko2016-02-231-2/+4
| | | | llvm-svn: 261642
* [ASTMatchers] Add matcher hasAnyName.Samuel Benzaquen2016-02-221-0/+10
| | | | | | | | | | | | Summary: Add matcher hasAnyName as an optimization over anyOf(hasName(),...) Reviewers: alexfh Subscribers: klimek, cfe-commits Differential Revision: http://reviews.llvm.org/D17163 llvm-svn: 261574
* [analyzer] dump_ast_matchers.py: fix replacement regexpsYury Gribov2016-02-181-3/+3
| | | | | | | | Patch by Alex Sidorin! Differential Revision: http://reviews.llvm.org/D17376 llvm-svn: 261219
* Properly encode the < entity; it was missing the semicolon. Regenerating ↵Aaron Ballman2016-01-221-1/+1
| | | | | | the AST matcher reference after fixing the issue. Thanks to Richard for noticing the issue and bringing it to my attention! llvm-svn: 258579
* When dumping documentation for AST matchers, do something more useful with ↵Aaron Ballman2016-01-211-0/+5
| | | | | | | | \see doxygen commands. Ideally this would link to the target of \see, but for now it translates \see into "See also: " Regenerate the AST documentation for this new functionality. llvm-svn: 258401
* Fix ASTMatcher reference newlines and make the generator script windows-proof.Benjamin Kramer2015-11-202-2/+2
| | | | llvm-svn: 253653
* clang-format: Hopefully fix code blocks in docs.Daniel Jasper2015-10-071-1/+1
| | | | | | Otherwise I will have to install sphinx ;).. llvm-svn: 249542
* clang-format: Add empty line before code-blocks in Docs.Daniel Jasper2015-10-061-1/+1
| | | | llvm-svn: 249394
* clang-format: Make IncludeCategories configurable in .clang-format file.Daniel Jasper2015-10-061-4/+6
| | | | | | | | | This was made much easier by introducing an IncludeCategory struct to replace the previously used std::pair. Also, cleaned up documentation and added examples. llvm-svn: 249392
* clang-format: Add a new brace style "custom" as well as flags toDaniel Jasper2015-09-291-4/+50
| | | | | | | | | | | | | | | control the individual braces. The existing choices for brace wrapping are now merely presets for the different flags that get expanded upon calling the reformat function. All presets have been chose to keep the existing formatting, so there shouldn't be any difference in formatting behavior. Also change the dump_format_style.py to properly document the nested structs that are used to keep these flags discoverable among all the configuration flags. llvm-svn: 248802
* Fix AST matcher documentation.Manuel Klimek2015-08-141-3/+3
| | | | | | | | | | | Fix a bug in the matcher docs where callExpr(on(...)) was in the examples, but didn't work (on() only works for memberCallExpr). Fix a bug in the doc dump script that was introduced in r231575 when removing a regexp capture without adapting the code that uses the captures. llvm-svn: 245040
* Sphinx-based clang man pagesAndrew Wilkins2015-06-303-986/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Summary: This diff introduces .rst files, Sphinx config, and a CMake target for building clang man pages. This will deprecate the existing .pod- based man page, and will integrate nicely with CMake. This diff does not remove the existing man page; that will be done in a follow-up once packagers have had a chance to react to the change. For now, only clang(1) has been done; others can be added over time by dropping additional files into the docs/CommandGuide directory. The index page for CommandGuide has been copied from LLVM's docs/CommandGuide. The man page itself is mostly the same, with a few minor cosmetic changes. The only major change is the SYNOPSIS section. I was unable to get .rst/Sphinx produce the same style as in the existing man page. Instead, I changed it to match the LLVM tools' relatively simple style. To build the man pages, use the "docs-clang-man" target if building with CMake. Otherwise, use "make -f Makefile.sphinx man". Reviewers: cmatthews, silvas Subscribers: dim, gaeke, beanz, cfe-commits Differential Revision: http://reviews.llvm.org/D10562 llvm-svn: 241037
* docs: grammar adjustments in clang manpageSaleem Abdulrasool2015-06-131-7/+7
| | | | | | | | Fix a few typos and run-on sentences in the clang POD documentation. Patch by Brian R. Gaeke! llvm-svn: 239652
* ASTMatchers: Make AST_POLYMORPHIC_SUPPORTED_TYPES a variadic macroBenjamin Kramer2015-03-071-2/+2
| | | | | | C++11 finally allows us to use this C99 feature. llvm-svn: 231575
* clang-format: Escape '*' in generated flag documentation.Daniel Jasper2014-12-021-0/+1
| | | | llvm-svn: 223118
* Document Darwin-specific defaults.Adrian Prantl2014-06-131-2/+3
| | | | llvm-svn: 210958
* clang-format: Update flag documentation, and generation script.Daniel Jasper2014-04-091-2/+3
| | | | llvm-svn: 205853
* Add loc() to the dynamic registry.Samuel Benzaquen2014-03-101-0/+19
| | | | | | | | | | | | | | | | | | Summary: Add loc() to the dynamic registry. Other fixes: - Fix the polymorphic variant value to accept an exact match, even if there are other possible conversions. - Fix specifiesTypeLoc() to not crash on an empty NestedNameSpecifierLoc. Reviewers: klimek CC: cfe-commits, klimek Differential Revision: http://llvm-reviews.chandlerc.com/D2928 llvm-svn: 203467
* "Mac OS/X" -> "Mac OS X" spelling fixes for clang.Nico Weber2014-03-071-1/+1
| | | | | | Patch from Sean McBride <sean@rogue-research.com>! llvm-svn: 203259
* Fix AST matcher documentation for overloaded matchers.Manuel Klimek2014-02-241-2/+2
| | | | | | | | Before this patch we would only use the fist occurance of a matcher function in the documentation, for example leaving out hasType(Matcher<QualType>). llvm-svn: 202019
* Fix docs generation for the AST matchers:Manuel Klimek2014-02-241-4/+9
| | | | | | | | | 1. Move internal functions into ASTMatchersInternal. 2. Adapt dump_ast_matchers.py to the new VariadicOperatorMatcherFunc signature. 3. Update the actual docs with the updated tool / code. llvm-svn: 202017
* clang-format: Improve documentation of DerivePointerBinding.Daniel Jasper2014-02-131-2/+2
| | | | | | | | For reference: llvm.org/PR18690. Also updated generated help page and page creation script. llvm-svn: 201323
* Driver: clarify help string for "-###"Tim Northover2014-01-141-1/+1
| | | | | | | | | | | | Someone recently wasted some time not realising that "-###" didn't actually execute the commands it printed, and suggested a documentation tweak. Having made the same mistake myself on at least one occasion, I sympathise. So here it is. Any kibitzing on an even better text welcome. llvm-svn: 199256
* Implement a new -fstandalone-debug option. rdar://problem/15685848Adrian Prantl2014-01-071-6/+13
| | | | | | | | | | | | | | It controls everything that -flimit-debug-info used to, plus the vtable type optimization. The old -fno-limit-debug-info option is now an alias to -fstandalone-debug and vice versa. Standalone is the default on Darwin until dtrace is updated to work with non-standalone debug info (rdar://problem/15758808). Note: I kept the LimitedDebugInfo name in CodeGenOptions::DebugInfoKind because NoStandaloneDebugInfo sounded even more confusing. llvm-svn: 198655
* Remove an outdated statement about debugging optimized code.Adrian Prantl2013-12-201-2/+1
| | | | llvm-svn: 197820
* Document the -fno-limit-debug-info switch in the man page.Adrian Prantl2013-12-201-0/+8
| | | | llvm-svn: 197819
* Remove clang man page reference to --analyze, and point people to the ↵Ted Kremenek2013-11-181-5/+2
| | | | | | analyzer website. llvm-svn: 195027
* Add partial support for the hasDeclaration() matcher in the dynamic layer.Samuel Benzaquen2013-11-181-1/+2
| | | | | | | | | | | | | | Summary: Add partial support for the hasDeclaration() matcher in the dynamic layer. This matcher has some special logic to allow any type that has a getDecl() method. We do not support this right now. Reviewers: klimek CC: cfe-commits, revane Differential Revision: http://llvm-reviews.chandlerc.com/D1889 llvm-svn: 195013
* Improve the documentation (bis) with Arthur and Chandler's commentsSylvestre Ledru2013-11-111-6/+2
| | | | llvm-svn: 194412
* Improve the documentation of the optimization flagsSylvestre Ledru2013-11-111-15/+51
| | | | | | | | | | | | Reviewers: rafael.espindola, rengolin, hfinkel Reviewed By: rengolin CC: cfe-commits Differential Revision: http://llvm-reviews.chandlerc.com/D2138 llvm-svn: 194405
* Added documentation for clang-format style options.Alexander Kornienko2013-09-041-0/+143
| | | | | | | | | | | | | | | | Summary: The main contents is in the ClangFormatStyleOptions.rst, which can be updated from the Format.h by the dump_format_style.py script. Reviewers: djasper, klimek Reviewed By: klimek CC: cfe-commits Differential Revision: http://llvm-reviews.chandlerc.com/D1597 llvm-svn: 189946
OpenPOWER on IntegriCloud