-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Summary: Pull Request resolved: #397 Reviewed By: simonmar Differential Revision: D51518900 Pulled By: donsbot fbshipit-source-id: 10f2f34095c47d8e757c7dc2fe09e97a2bba8330
- Loading branch information
1 parent
ade39b4
commit 1c7abf4
Showing
3 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
id: scip-dotnet | ||
title: Dotnet | ||
sidebar_label: Dotnet | ||
--- | ||
|
||
import {OssOnly, FbInternalOnly} from 'internaldocs-fb-helpers'; | ||
import {SrcFile,SrcFileLink} from '@site/utils'; | ||
|
||
To index [Dotnet](https://dotnet.microsoft.com/) we use SourceGraph's [SCIP indexer for dotnet](https://github.com/sourcegraph/scip-dotnet). [SCIP](https://about.sourcegraph.com/blog/announcing-scip) is a new format for tools to share information about code. Releases of [scip-dotnet](https://github.com/sourcegraph/scip-dotnet) can be installed with `dotnet tools` and used as indexers for SCIP, which Glean will accept. The indexer itself requires a [dotnet](https://dotnet.microsoft.com/) runtime environment. | ||
|
||
## Run the indexer | ||
|
||
The indexer is run via the main `glean` CLI tool. | ||
|
||
``` | ||
> cabal build exe:glean | ||
``` | ||
|
||
And index your Dotnet repository with: | ||
``` | ||
glean index dotnet-scip DIR --db NAME/INSTANCE | ||
``` | ||
|
||
where | ||
|
||
* `DIR` is the root directory containing the Dotnet project | ||
* `name/hash` is the name of the repository to create | ||
|
||
Provide the usual `--db-root` and `--schema` or `--service` arguments | ||
to `glean` | ||
|
||
## In the shell | ||
|
||
Dotnet source can also be indexed directly from the Glean shell: | ||
|
||
``` | ||
:index dotnet-scip DIR | ||
``` | ||
|
||
The shell will pick a DB name and hash for you based on `DIR`. | ||
|
||
## Schema | ||
|
||
The schema is in <SrcFile file="glean/schema/source/scip.angle" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters