Google Git
Sign in
gerrit / zoekt / 0b109d08df69cedc884261ea73f7d03c8168f57f
commit0b109d08df69cedc884261ea73f7d03c8168f57f[log] [tgz]
authorHan-Wen Nienhuys <hanwen@google.com>Wed Dec 11 20:17:49 2019 +0100
committerHan-Wen Nienhuys <hanwen@google.com>Wed Dec 11 19:20:39 2019 +0000
treef71db294f31f46ca220cadf70b5a6a0145f3fb5b
parentbddeed6fc4726819c3a0ba268e98c87d47672606 [diff]
gitindex: set fetch refspecs after cloning

A recent Git release broke the capability to set refspecs on the
command-line. This was stopped in 47ff3037, and as a result fetches
now update FETCH_HEAD rather than the required refs.

Instead, set the refspecs to refs/heads/* => refs/heads/* after the
successful clone.

Fixes #106

Change-Id: I1907094aecd81e35d2081218ccbe8d005caf4863
2 files changed
tree: f71db294f31f46ca220cadf70b5a6a0145f3fb5b
  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. go.mod
  19. go.sum
  20. hititer.go
  21. hititer_test.go
  22. index_test.go
  23. indexbuilder.go
  24. indexdata.go
  25. indexfile.go
  26. indexfile_linux.go
  27. LICENSE
  28. matchiter.go
  29. matchtree.go
  30. matchtree_test.go
  31. read.go
  32. read_test.go
  33. README.md
  34. section.go
  35. section_test.go
  36. toc.go
  37. 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