averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity
72,526 Commits 622 Branches 2,942 Tags
dadb51e708315cec33b80cb46ad846d44ab6ad67
Commit Graph

40 Commits

Author SHA1 Message Date
Michael Gottesman
e29c61e73e Merge pull request #17560 from gottesmm/pr-9d67c5b273eaafb2b9bb9f0568014de4ab1296af 
[docs] Add a small section about running the static analyzer via clan…
 2018-06-27 17:02:21 -07:00
Michael Gottesman
4a0409c1ff [docs] Add a link in DebuggingTheCompiler to the manual symbolication lldb guide on llvm.org 2018-06-27 09:21:27 -07:00
Michael Gottesman
35c99da8cd [docs] Add a small section about running the static analyzer via clang-tidy using compile_commands.json 
I have been doing this every once in a while to look for problems. No point in
siloing this knowledge in my brain.
 2018-06-27 09:21:10 -07:00
Michael Gottesman
968835a1ac Make Debugging Executables/LLDB top level section 
Previously these were under "Debugging the Compiler"... but really they are more general so it makes sense for them to have their own sections.
 2018-06-25 09:58:31 -07:00
Dave Lee
f9cc272d95 Mention sequence in DebuggingTheCompiler 2018-03-30 13:31:18 -07:00
Vedant Kumar
a57ba2b0c2 [docs] Explain how to define custom lldb commands 2018-03-29 20:53:14 -07:00
John Eismeier
09452396cc Propose fixing some typos 2018-02-15 14:37:51 -05:00
Erik Eckstein
4a0ec87294 docs: Mention the blockifyasm script in DebuggingTheCompiler 2018-02-02 15:31:47 -08:00
Michael Gottesman
05deb32e52 [docs] Add a section about debugging the typechecker to DebuggingTheCompiler.rst. 2017-12-08 18:38:00 -08:00
Michael Gottesman
b99ac1e4ff [docs] Be consistent about rst headings. 2017-12-08 18:29:12 -08:00
Erik Eckstein
47e5a0757a A utility script to split long swift compiler command lines. 
For details see the comment in split-cmdline

I put this under a new directory utils/dev-script because we have so much stuff in utils already.
Other, similar scripts can then be added in dev-scripts as well.
 2017-10-29 15:27:32 -07:00
Michael Gottesman
cc39b5ffdf [docs] Update DebuggingTheCompiler.rst section with info about vim/emacs integration for viewcfg. 2017-10-17 14:58:40 -07:00
Robert Widmann
24154254b5 Change a literal block to a colon 
Lack of indentation on the bulleted list broke builds involving CMark.
 2017-10-12 02:54:38 -04:00
Michael Gottesman
0c49657a0e [docs] Add a section to DebuggingTheCompiler on debugging compiler failures in LLDB. 
I ran into such an issue and realized I didn't know how to dump SIL from LLDB
and more importantly that it was not documented anywhere. Now it is documented
and I can avoid bugging Jim Ingham on this topic ever again.
 2017-10-11 14:44:29 -07:00
Michael Gottesman
50f0accf39 [viewcfg] Reformulate, expand the docs on viewcfg. 
Specifically, I tried to make it clearer that viewcfg does not rely on any type
information or declarations (i.e. it can dump raw textual CFGs). This also means
that it can be used in an editor to dump CFGs at your cursor?!

Thanks Erik for showing me this!
 2017-06-30 22:03:27 -07:00
Erik Eckstein
ef011690e3 Revert "[docs] DebuggingTheCompiler.rst => DebuggingTheCompiler.md." 
This reverts commit 444920f2b6.

Caused the build failure: toctree contains reference to nonexisting document u'DebuggingTheCompiler'
 2016-12-14 15:00:02 -08:00
Michael Gottesman
444920f2b6 [docs] DebuggingTheCompiler.rst => DebuggingTheCompiler.md. 
Inspired by Joe Groff's comment about converting Lexicon.rst => Lexicon.md.
 2016-12-14 11:28:24 -08:00
Michael Gottesman
de4c881477 [sil-bug-reducer] Call out in DebuggingTheCompiler.rst the existance of sil-bug-reducer and where to find docs for it. 2016-12-13 10:21:23 -08:00
Jordan Rose
ca14c36936 [docs] Fix syntax highlighting issues to support newer Sphinxes. (#4283) 
- Update the Pygments lexer we use for parsing Swift-like code.
- State more explicitly which highlighting should be used in which
  code blocks.
- Disable highlighting altogether in certain cases (such as SIL.rst,
  which has equal amounts grammar and SIL excerpts).

This should fix the warnings-as-error issues coming from Sphinx > 1.3.4.

Based on a patch by Jeremy Fergason!

https://bugs.swift.org/browse/SR-620
 2016-08-12 22:59:11 -07:00
practicalswift
db6890fd26 [gardening] Use consistent capitalization for "Python". 2016-06-14 23:18:00 +02:00
hitstergtd
1ccca9d0f0 [gardening] Properly capitalise 'swift' to 'Swift' 2016-04-17 20:53:48 +01:00
Erik Eckstein
b332321457 docs: document the --build-sil-debugging-stdlib option 2016-03-30 11:26:15 -07:00
Erik Eckstein
6d654aa3e8 Debugging on SIL level. 
This change follows up on an idea from Michael (thanks!).
It enables debugging and profiling on SIL level, which is useful for compiler debugging.

There is a new frontend option -gsil which lets the compiler write a SIL file and generated debug info for it.
For details see docs/DebuggingTheCompiler.rst and the comments in SILDebugInfoGenerator.cpp.
 2016-03-18 14:02:06 -07:00
the lel
233150028b Grammar - adds 'you' 2015-12-16 06:33:05 +05:30
the lel
ed5a71ab42 Slight grammatical improvement. 2015-12-15 22:18:27 +05:30
Max Ovtsin
2e020bb7a3 Fix docs 2015-12-07 18:53:16 +03:00
J. Gavin Ray
c08685d3bf Typo in Documentation 
afer -> after
 2015-12-04 06:22:20 -08:00
John Andrews
dc451c4d5d Fix typo and grammar in docs/DebuggingTheCompiler.rst 2015-12-03 17:21:03 -08:00
Erik Eckstein
e5f6eb3671 Add a convenience function hasName in SILFunction to be used in the debugger. 
This is a replacement for getName().equals("..."), which is no longer callable from the debugger with the latest llvm changes.



Swift SVN r32895
 2015-10-26 21:52:37 +00:00
Joe Groff
0cd5aa8c7c Change mangling for the Swift module from 'Ss' to 's'. 
'Ss' appears in manglings tens of thousands of times in the standard library and is also incredibly frequent in other modules. This alone is enough to shrink the standard library by 59KB.

Swift SVN r32409
 2015-10-02 22:39:44 +00:00
Mark Lacey
91f51cd683 Minor tweak to referenced filename. 
Swift SVN r31193
 2015-08-12 22:15:32 +00:00
Michael Gottesman
40dd888e59 [docs] Fix up formatting so that we use "::" and so that we follow the flow of the document better. 
Swift SVN r31124
 2015-08-10 21:05:03 +00:00
Michael Gottesman
5fd76f137e [docs] Fix indentation to make sphinx happy (even though it won't match lldb exactly anymore). 
Swift SVN r31123
 2015-08-10 20:56:49 +00:00
Michael Gottesman
a2bcc33576 [docs] Wordsmith a little bit to make things clearer. 
Swift SVN r31122
 2015-08-10 20:46:21 +00:00
Michael Gottesman
3c930a4972 [docs] Move sections about LLDB usage under Advanced LLDB Usage. 
This includes:

1. Using Breakpoints.
2. LLDB Scripts.
3. Determining Mangled Names.

Swift SVN r31121
 2015-08-10 20:42:06 +00:00
Michael Gottesman
b92811d44f [docs] Show how to lookup the mangled name of a demangled swift function name in lldb. 
Swift SVN r31118
 2015-08-10 20:39:12 +00:00
Michael Gottesman
84252dc759 [docs] Add a section to DebuggingTheCompiler that shows how to use the '-s' command to lldb to script complex debugger workflows quickly and easily. 
The example given is something that I actually used recently.

Swift SVN r31116
 2015-08-10 20:19:41 +00:00
Michael Gottesman
2f91bf26bd [docs] Add the large ignore count technique to the breakpoint part of DebuggingTheCompiler. 
Swift SVN r31115
 2015-08-10 20:19:40 +00:00
Erik Eckstein
b0bcad7887 Add a utility script for displaying the CFG of SIL or LLVM IR. 
It is useful if you have the SIL already in a file (instead of calling viewCFG() while running the compiler in lldb).

Especially useful for vim users: see the comment in the script on how to add commands to view the CFG from inside vim.




Swift SVN r30186
 2015-07-14 16:22:52 +00:00
Erik Eckstein
bbd503545c Add a document which contains some tips and tricks on how to debug the swift compiler. 
This could be useful for people who start working with the swift compiler.

Please feel free to correct/enhance/extend etc.



Swift SVN r29383
 2015-06-15 11:26:17 +00:00