Describe the console app TxFmt in the troubleshooting doc

This commit is contained in:
georgis 2014-10-07 17:13:38 -07:00
Родитель 634bfcdca0
Коммит 5574b18f97
2 изменённых файлов: 41 добавлений и 9 удалений

25
Doc/GetTxCode.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
# Getting local copy of the Tx code and documentation
There are two ways to get local copy:
1) Click on the SOURCE CODE tab, and then on the Download button
This downloads a zip file, and useful if you want to take a quick look
2) Using [Git](http://git-scm.com/book/en/Getting-Started-Git-Basics) as source control:
* Install [Github for Windows](http://windows.github.com/)
* launch the Git Shell, and choose one of the three repositories we keep in sync:
* **git clone https://git01.codeplex.com/tx**
* **git clone https://github.com/MSOpenTech/Tx.git**
* **git clone https://github.com/Reactive-Extensions/Tx.git**
The documentation comes interleaved with the source code
* To view or edit the docs, please install [MarkDownPad](http://www.markdownpad.com/)
* To open the documents full screen, click Tools, Preview Markdown in Browser (F6)
We wish our documentation showed on CodePlex as good as Github. Specific issues are:
* [Support for relative links in MarkDown](https://codeplex.codeplex.com/workitem/27249)
* [Markdown layout is broken in source code browser](https://codeplex.codeplex.com/workitem/26990)

Просмотреть файл

@ -1,14 +1,6 @@
# Troubleshooting Tx
There are two ways of getting the Tx source code:
* Click on the SOURCE CODE tab, and then on the Download button
* Using [Git](http://git-scm.com/book/en/Getting-Started-Git-Basics) as source control:
* Install [Github for Windows](http://windows.github.com/)
* launch the Github Shell, and type: **git clone https://git01.codeplex.com/tx**
The first method is a quick way to take first look at Tx, or debug a problem.
The second allows you to pull subsequent changes, see the history, etc.
First step is to [get the Tx code and docs](GetTxCode.md) on your local machine
## LINQPad Driver
@ -29,3 +21,18 @@ In Visual Studio:
Example: /m:myManifest.man
## Run-time reading + formatting (e.g. issues with SvnPerf)
Many people don't use Tx directly, but use [SvcPerf](http://svcperf.codeplex.com). The default view of SvcPerf reads all events and uses the "Timeline Mode" described in [Playback Features](PlaybackFeatures.md).
To troubleshoot Tx in a simpler way
* Set the console application [TxFmt](../Source/TxFmt/Program.cs) as default project
* In the Properties\Debugging add some manifest and etl files as command line arguments
* Enable first-chance exceptions and run
This allows to debug all non-UI parts of Tx (type-generation, reading, formatting)