Clean up readme for extractrepo/repotester.
Reviewers: craigbarber, jrtom
Subscribers: jrtom, #core_team
@@ -19,10 +19,12 @@ process are [kindex files](http://kythe.io/docs/kythe-index-pack.html).
### Build Instructions
To build the `extractrepo.go` binary use the following bazel command:
+
`bazel build //kythe/go/platform/tools/extraction:extractrepo`
It may also be necessary to build the relevant extractors that you are going to
be running:
+
`bazel build //kythe/java/com/google/devtools/kythe/extractors/java/artifacts`
### Usage
@@ -36,11 +38,11 @@ container registry from within the executing host environment.
## `repotester.go`
This tool wraps the above `extractrepo.go` tool and provides testing of input
-repos, verifying that its output is sensible. It does this by separately looking
-at the contents of the github repo using the `go-github` API v3 and comparing the
-contents with the extractor's `.kindex` output. For just extraction, it uses
-simple filename comparison. When indexing is supported in the future, we will
-extend this tool to look at symbol names as well.
+repos, verifying that its output is sensible. It does this by separately cloning
+the contents of the github repo and comparing them with the extractor's
+`.kindex` output. For just extraction, it uses simple filename comparison. When
+indexing is supported in the future, we will extend this tool to look at symbol
+names as well.
In order to run `repotester.go`, you may first want to verify that extraction
works as above. Many of the problems you'll run into with `repotester.go` will
@@ -50,18 +52,8 @@ extraction config.
### Build Instructions
To build the `repotester.go` binary, use the following bazel command:
-`bazel build //kythe/go/platform/tools/extraction:repotester`
-
-### Github API Token
-To do anything interesting with repotester you likely need to get a Github
-personal API token, or you'll be restricted to using the tiny freebie quota. To
-do so, follow these instructions:
-
-https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
-
-Note that at step #7, you only need to ask for the `public_repo` permission bit.
-Save the resulting key and store it somewhere safe for re-use.
+`bazel build //kythe/go/platform/tools/extraction:repotester`
### Usage
@@ -69,8 +61,7 @@ These instructions assume that any required Docker images referred to in the
extraction configuration file are accessible either from a local or remote
contanier registry from within the executing host environment.
-`repotester -repos <repo_list> -config <config_file_path> -github_token
-<personal_api_token>`
+`repotester -repos <repo_list> -config <config_file_path>`
`repo_list` can be a comma separated list of github repo urls, e.g.
`"https://github.com/google/kythe,https://github.com/google/go-github"`.
