You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 12, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+46-18Lines changed: 46 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@ GitLink
5
5
6
6
GitLink let's users step through your code hosted on GitHub! **Help make .NET open source projects more accessible by enabling this for your .NET projects, it's just a single additional step in your build**. See the list of [projects using GitLink](#projects-using-gitlink).
7
7
8
+
<ahref="https://pledgie.com/campaigns/26957"><imgalt="Click here to lend your support to: GitLink and make a donation at pledgie.com !"src="https://pledgie.com/campaigns/26957.png?skin_name=chrome"border="0" /></a>
9
+
8
10
--
9
11
10
12
**Important note**
@@ -28,8 +30,14 @@ When using GitLink, the user no longer has to specify symbol servers. He/she onl
28
30
29
31

30
32
33
+
# Troubleshooting
34
+
31
35
**Note that Visual Studio 2012 needs to run elevated in order to download the source server files due to a bug in Visual Studio 2012.**
32
36
37
+
If the source stepping is not working, double check that Visual Studio has a valid symbol cache directory to store the source files being downloaded:
38
+
39
+

40
+
33
41
# Supported git providers
34
42
35
43
GitLink supports the following providers out of the box (will auto-detect based on the url):
@@ -51,7 +59,7 @@ Providers currently being worked on:
51
59
52
60
It is also possible to specify a custom url provider.
53
61
54
-
# Using GitLink as command line tool #
62
+
# Using GitLink as command line tool
55
63
56
64
Using GitLink via the command line is very simple:
57
65
@@ -60,44 +68,55 @@ Using GitLink via the command line is very simple:
This will use the default branch (which is in most cases **master**). You can find out the default branch by checking what branch is loaded by default on the GitHub page.
This will use the develop branch and the debug configuration.
80
88
81
-
## Getting help ##
89
+
## Running for a specific solution only
90
+
91
+
Sometimes a repository contains more than 1 solution file. By default, all solutions will be processed. To only process a single solution file, use the *-f* option:
GitLink is built with 2 usages in mind: command line and code reference. Though most people will use the command line version, it is possible to reference the executable and use the logic in code.
97
116
98
117
The command line implementation uses the same available API.
99
118
100
-
## Creating a context ##
119
+
## Creating a context
101
120
102
121
To link files to a Git project, a context must be created. The command line version does this by using the *ArgumentParser* class. It is also possible to create a context from scratch as shown in the example below:
103
122
@@ -114,33 +133,33 @@ It is possible to create a context based on command line arguments:
Once a context is created, the *Linker* class can be used to actually link the files:
120
139
121
140
Linker.Link(context);
122
141
123
-
# How to get GitLink #
142
+
# How to get GitLink
124
143
125
-
There are three general ways to get GitLink:.
144
+
There are three general ways to get GitLink:
126
145
127
-
## Get it from GitHub ##
146
+
## Get it from GitHub
128
147
129
148
The releases will be available as separate executable download on the [releases tab](https://github.com/CatenaLogic/GitLink/releases) of the project.
130
149
131
-
## Get it via Chocolatey ##
150
+
## Get it via Chocolatey
132
151
133
152
If you want to install the tool on your (build) computer, the package is available via <ahref="https://chocolatey.org/"target="_blank">Chocolatey</a>. To install, use the following command:
134
153
135
154
choco install GitLink
136
155
137
-
## Get it via NuGet ##
156
+
## Get it via NuGet
138
157
139
158
If you want to reference the assembly to use it in code, the recommended way to get it is via <ahref="http://www.nuget.org/"target="_blank">NuGet</a>.
140
159
141
160
**Note that getting GitLink via NuGet will add it as a reference to the project**
142
161
143
-
# How does it work #
162
+
# How does it work
144
163
145
164
The SrcSrv tool (Srcsrv.dll) enables a client to retrieve the exact version of the source files that were used to build an application. Because the source code for a module can change between versions and over the course of years, it is important to look at the source code as it existed when the version of the module in question was built.
146
165
@@ -149,18 +168,27 @@ For more information, see the <a href="http://msdn.microsoft.com/en-us/library/w
149
168
GitLink creates a source index file and updates the PDB file so it will retrieve the files from the Git host file handler.
150
169
151
170
<aname="projects-using-gitlink"></a>
152
-
# Projects using GitLink #
171
+
# Projects using GitLink
153
172
154
173
Below is a list of projects already using GitLink (alphabetically ordered).
0 commit comments