summaryrefslogtreecommitdiffstats
path: root/clang/docs/tools/clang.pod
Commit message (Collapse)AuthorAgeFilesLines
* Sphinx-based clang man pagesAndrew Wilkins2015-06-301-614/+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
* Document Darwin-specific defaults.Adrian Prantl2014-06-131-2/+3
| | | | llvm-svn: 210958
* "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
* 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
* 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
* Add description of -Ofast optimization option to the man page. <rdar://13660458>Bob Wilson2013-04-171-3/+5
| | | | llvm-svn: 179733
* Revert "Remove sparse text on diagnostic options. These are not really ↵Ted Kremenek2013-02-051-0/+21
| | | | | | | | documented anywhere, and they really aren't for normal users." I changed my mind. We should just document these in the man page. llvm-svn: 174344
* Remove sparse text on diagnostic options. These are not really documented ↵Ted Kremenek2013-02-051-21/+0
| | | | | | anywhere, and they really aren't for normal users. llvm-svn: 174338
* Fix copy-paste error in manpage. Should be -stdlib=library.Ted Kremenek2012-09-141-1/+1
| | | | llvm-svn: 163914
* Revert "Remove clang man page reference to -Oz. It's not an option we want ↵Ted Kremenek2012-09-101-3/+4
| | | | | | | | people to use, and is around for historical reasons." This should be discussed more first. llvm-svn: 163560
* Remove clang man page reference to -Oz. It's not an option we want people ↵Ted Kremenek2012-09-101-4/+3
| | | | | | to use, and is around for historical reasons. llvm-svn: 163538
* Add -ftls-model command-line flag.Hans Wennborg2012-06-281-0/+8
| | | | | | This allows for setting the default TLS model. (PR9788) llvm-svn: 159336
* Fix a typo (builting -> builtin).Benjamin Kramer2012-02-051-1/+1
| | | | | | Patch by Afriza N. Arief! llvm-svn: 149822
* Driver: Add support for a new -nostdlibinc option.Daniel Dunbar2011-10-111-1/+7
| | | | | | | | | | | | - This disables the system include directories, but not the compiler builtin directories. Useful for projects that want to use things like the intrinsic headers, but are otherwise freestanding. - I'm willing to reconsider the option naming, I also considered providing an explicit -builtinc (which would match -nobuiltininc), but this is more consistent with existing options. llvm-svn: 141692
* Revert my --working-directory option, which wasn't well thought through.Daniel Dunbar2011-09-301-7/+0
| | | | llvm-svn: 140889
* Driver: Add a --working-directory option which can be used to cause the compilerDaniel Dunbar2011-09-231-0/+7
| | | | | | | | | | to operate "as if" in a certain working directory. - For now, we just implement this by changing the actual working directory, but eventually we would want to handle this transparently. This is useful to avoid an extra exec() pair in some situations, and will be something we would want to support for more flexibility in using the Clang libraries. llvm-svn: 140409
* Documentation for -Oz; Updated synopsis and item.Chad Rosier2011-04-301-2/+2
| | | | llvm-svn: 130570
* Add documentation for -Oz flag.Chad Rosier2011-04-301-1/+2
| | | | llvm-svn: 130569
* fix a bunch of comment typos found by codespell. Patch byChris Lattner2011-04-151-1/+1
| | | | | | Luis Felipe Strano Moraes! llvm-svn: 129559
* Remove '-Xclang' and '-mllvm' entries from Clang man page. The later is ↵Ted Kremenek2011-03-181-8/+0
| | | | | | only available in debug builds and the former is not supposed to be used by end-users. llvm-svn: 127914
* Reorganize predefined macros for all Windows targets.Michael J. Spencer2010-10-211-0/+4
| | | | | | | | | | This adds an option to set the _MSC_VER macro without recompiling. This is very useful when testing compatibility with the Windows SDK and c++stdlib headers. -fmsc-version=<version> (defaults to VS2003 (1300)) llvm-svn: 116999
* Fix a typo in the Clang man page, from Alexander Best.Douglas Gregor2010-10-081-1/+1
| | | | llvm-svn: 116102
* Update Clang man page to say a little bit more about C++Douglas Gregor2010-09-241-3/+4
| | | | llvm-svn: 114735
* Driver/Objective-C: Retool Objective-C ABI flags to be more usable, and actuallyDaniel Dunbar2010-09-201-1/+16
| | | | | | document behavior. Will wonders never cease. llvm-svn: 114334
* Driver: Add a -stdlib= argument which can be used to select the C++ standardDaniel Dunbar2010-09-141-0/+6
| | | | | | | | | | | library to use. - This is currently useful for testing libc++; you can now use 'clang++ -stdlib=libc++ t.cpp' to compile using it if installed. - In the future could also be used to select other standard library choices if alternatives become available (for example, to use an alternate C library). llvm-svn: 113891
* Add support for Borland extensions via option -fborland-extensionsDawn Perchik2010-09-021-0/+4
| | | | | | (original patch r112791 was reverted due to a bug). llvm-svn: 112915
* Reverting rev 112791 - apparently -fborland-extensions is on all the time?!Dawn Perchik2010-09-021-4/+0
| | | | llvm-svn: 112797
* Add support for Borland extensions via option -fborland-extensionsDawn Perchik2010-09-021-0/+4
| | | | llvm-svn: 112791
* Add machine-parseable Fix-It output as part of diagnostics, under theDouglas Gregor2010-08-191-0/+1
| | | | | | flag -fdiagnostics-parseable-fixits, from Eelis van der Weegen! llvm-svn: 111557
* Remove a gratuitous lie.Daniel Dunbar2010-08-171-1/+0
| | | | llvm-svn: 111253
* docs: Man page tweaks, to mention the integrated assembler and theDaniel Dunbar2010-05-211-6/+19
| | | | | | -integrated-as and -no-integrated-as options. llvm-svn: 104304
* Document -nobuiltinincRafael Espindola2009-10-271-0/+4
| | | | llvm-svn: 85188
* Some formatting tweaks to clang(1)Daniel Dunbar2009-09-131-24/+24
| | | | llvm-svn: 81668
* Several fixes to the clang man page.Daniel Dunbar2009-05-181-24/+21
| | | | | | | | | | | | | | - -emit-llvm isn't a stage selection option. - Document -O4 and -flto. - -ObjC++ and -ObjC apply to all inputs, not subsequent ones. - Some versions of pod2man aren't happy about the comment after =over=? - Some minor grammar fixes. llvm-svn: 72044
* wrap up a version of the man page that is minimally helpful, but somewhat ↵Chris Lattner2009-05-121-45/+31
| | | | | | complete. llvm-svn: 71524
* add some more content.Chris Lattner2009-05-121-80/+182
| | | | llvm-svn: 71518
* pull a bunch of options out of clang-cc.cpp. This doesn't includeChris Lattner2009-05-111-17/+141
| | | | | | options that the driver swizzles. llvm-svn: 71487
* Document environment variables we handle, and don't mention -pipe (itDaniel Dunbar2009-05-061-8/+30
| | | | | | isn't yet supported... lazy developers). llvm-svn: 71109
* More content.Chris Lattner2009-05-061-23/+82
| | | | llvm-svn: 71088
* add some contentChris Lattner2009-05-061-24/+97
| | | | llvm-svn: 71059
* Add incredibly bare bones docs/tools.Daniel Dunbar2009-04-291-0/+151
- Mirroring LLVM's docs/CommandGuide, a place to put .pod files which are used to generate man/html/etc documentation for tools provided as part of clang. llvm-svn: 70355
OpenPOWER on IntegriCloud