Skip to content
This repository has been archived by the owner on Apr 16, 2020. It is now read-only.

Commit

Permalink
update description for a 3.0.0 (#354)
Browse files Browse the repository at this point in the history
  • Loading branch information
ctaggart authored Jun 23, 2018
1 parent 636075e commit 0bf49f9
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Most of the SourceLink 2 tools from this repository are made obsolete by the .NE

# Test

For SourceLink version 3, [sourcelink](https://www.nuget.org/packages/SourceLink/3.0.0-build.732) is a [.NET Core global tool](https://natemcmaster.com/blog/2018/05/12/dotnet-global-tools/).
For SourceLink version 3, [sourcelink](https://www.nuget.org/packages/SourceLink) is a [.NET Core global tool](https://natemcmaster.com/blog/2018/05/12/dotnet-global-tools/).
```
dotnet tool install --global sourcelink --version 3.0.0-build.732
dotnet tool install --global sourcelink
```

`sourcelink` is a command you can use to test that the source link works. It makes sure all links work for every source file that is not embedded in the PDB. You can test a nupkg, a pdb, or a dll if the pdb is embedded. Run `sourcelink` without any options for a list of diagnostic commands and help:
`sourcelink` is a tool to test that the source link enabled nupkg or pdb file work. It tests all source files listed in the pdb. You can also print diagnostic information for a pdb. Run `sourcelink` without any options for a list of diagnostic commands and help:

```
SourceLink 3.0.0-build.732
SourceLink 3.0.0
Source Code On Demand
Usage: [options] [command]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<IncludeBuildOutput>false</IncludeBuildOutput>
<!--<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>-->
<DevelopmentDependency>True</DevelopmentDependency>
<Description>A tool to help enable source link for pdb files using command line applications. git is used by default.</Description>
</PropertyGroup>

<ItemGroup>
Expand Down
4 changes: 0 additions & 4 deletions build/common.props
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,5 @@
<PackageIconUrl>https://ctaggart.github.io/SourceLink/SourceLink128.jpg</PackageIconUrl>
<PackageProjectUrl>https://github.com/ctaggart/SourceLink</PackageProjectUrl>
<PackageTags>sourcelink pdb symbols git sourceindexing debugging sourceserver build</PackageTags>
<Description>
SourceLink: Source Code On Demand
Source Link your Portable PDB files to allow source code to be downloaded on demand
</Description>
</PropertyGroup>
</Project>
1 change: 1 addition & 0 deletions dotnet-sourcelink/sourcelink.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<RootNamespace>SourceLink</RootNamespace>
<ToolCommandName>sourcelink</ToolCommandName>
<PackAsTool>True</PackAsTool>
<Description>A tool to test that the source link enabled nupkg or pdb file work. It tests all source files listed in the pdb. You can also print diagnostic information for a pdb.</Description>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.CommandLineUtils" Version="1.1.1" />
Expand Down

0 comments on commit 0bf49f9

Please sign in to comment.