Google Git
Sign in
gerrit / zoekt / 0a98eeed9b5869fbe2a7c7aefb37d147d3715f01
commit0a98eeed9b5869fbe2a7c7aefb37d147d3715f01[log] [tgz]
authorKeegan Carruthers-Smith <keegan.csmith@gmail.com>Tue Jul 20 22:03:08 2021 +0200
committerKeegan Carruthers-Smith <keegan.csmith@gmail.com>Tue Jul 20 22:03:08 2021 +0200
tree708e2fbce9b251ae0ca719ac27f2fbbea2484d87
parent253a9c52c3f10110a93ee75474c1df8d3b4fe914 [diff]
indexbuilder: avoid writing root in SubRepoMap

We currently duplicate the root Repository under SubRepoMap[""]. From
what I can tell this is unnecessary since we never read it. The only
read path for subRepoPaths never read the root SubRepoMap (it checked
subRepoID > 0).

IndexBuilder now avoids marshalling out the root in
SubRepoMap. Additionally when reading we ignore the root SubRepoMap for
backwards compatibility.

Change-Id: I4455ed1019b1ae3debce789da51c5e009c7058c5
2 files changed
tree: 708e2fbce9b251ae0ca719ac27f2fbbea2484d87
  1. build/
  2. cmd/
  3. ctags/
  4. doc/
  5. gitindex/
  6. query/
  7. shards/
  8. web/
  9. .gitignore
  10. all.bash
  11. api.go
  12. bits.go
  13. bits_test.go
  14. build-deploy.sh
  15. contentprovider.go
  16. CONTRIBUTING
  17. eval.go
  18. eval_test.go
  19. go.mod
  20. go.sum
  21. hititer.go
  22. hititer_test.go
  23. index_test.go
  24. indexbuilder.go
  25. indexdata.go
  26. indexfile_other.go
  27. indexfile_unix.go
  28. LICENSE
  29. matchiter.go
  30. matchtree.go
  31. matchtree_test.go
  32. read.go
  33. read_test.go
  34. README.md
  35. section.go
  36. section_test.go
  37. toc.go
  38. write.go
README.md
"Zoekt, en gij zult spinazie eten" - Jan Eertink

("seek, and ye shall eat spinach" - My primary school teacher)

This is a fast text search engine, intended for use with source code. (Pronunciation: roughly as you would pronounce “zooked” in English)

INSTRUCTIONS

Downloading:

go get github.com/google/zoekt/

Indexing:

go install github.com/google/zoekt/cmd/zoekt-index
$GOPATH/bin/zoekt-index .

Searching

go install github.com/google/zoekt/cmd/zoekt
$GOPATH/bin/zoekt 'ngram f:READ'

Indexing git repositories:

go install github.com/google/zoekt/cmd/zoekt-git-index
$GOPATH/bin/zoekt-git-index -branches master,stable-1.4 -prefix origin/ .

Indexing repo repositories:

go install github.com/google/zoekt/cmd/zoekt-{repo-index,mirror-gitiles}
zoekt-mirror-gitiles -dest ~/repos/ https://gfiber.googlesource.com
zoekt-repo-index \
   -name gfiber \
   -base_url https://gfiber.googlesource.com/ \
   -manifest_repo ~/repos/gfiber.googlesource.com/manifests.git \
   -repo_cache ~/repos \
   -manifest_rev_prefix=refs/heads/ --rev_prefix= \
   master:default_unrestricted.xml

Starting the web interface

go install github.com/google/zoekt/cmd/zoekt-webserver
$GOPATH/bin/zoekt-webserver -listen :6070

A more organized installation on a Linux server should use a systemd unit file, eg.

[Unit]
Description=zoekt webserver

[Service]
ExecStart=/zoekt/bin/zoekt-webserver -index /zoekt/index -listen :443  --ssl_cert /zoekt/etc/cert.pem   --ssl_key /zoekt/etc/key.pem
Restart=always

[Install]
WantedBy=default.target

SEARCH SERVICE

Zoekt comes with a small service management program:

go install github.com/google/zoekt/cmd/zoekt-indexserver

cat << EOF > config.json
[{"GithubUser": "username"},
 {"GithubOrg": "org"},
 {"GitilesURL": "https://gerrit.googlesource.com", "Name": "zoekt" }
]
EOF

$GOPATH/bin/zoekt-server -mirror_config config.json

This will mirror all repos under ‘github.com/username’, ‘github.com/org’, as well as the ‘zoekt’ repository. It will index the repositories.

It takes care of fetching and indexing new data and cleaning up logfiles.

The webserver can be started from a standard service management framework, such as systemd.

SYMBOL SEARCH

It is recommended to install Universal ctags to improve ranking. See here for more information.

ACKNOWLEDGEMENTS

Thanks to Alexander Neubeck for coming up with this idea, and helping me flesh it out.

DISCLAIMER

This is not an official Google product