1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2024-12-12 19:18:24 +02:00
ripgrep/ci/docker/README.md
Chayoung You 16a1221fc7 doc: use asciidoctor instead of a2x
AsciiDoc development is continued under asciidoctor. See
https://github.com/asciidoc/asciidoc.

We do however fallback to a2x if asciidoctor is not present. This is to
ease migration, but at some point, it's likely that support for a2x will
be dropped.

Originally reported downstream:
https://github.com/Homebrew/linuxbrew-core/issues/19885

Closes #1544
2020-05-08 23:24:40 -04:00

1.1 KiB

These are Docker images used for cross compilation in CI builds (or locally) via the Cross tool.

The Cross tool actually provides its own Docker images, and all Docker images in this directory are derived from one of them. We provide our own in order to customize the environment. For example, we need to install some things like asciidoctor in order to generate man pages. We also install compression tools like xz so that tests for the -z/--search-zip flag are run.

If you make a change to a Docker image, then you can re-build it. cd into the directory containing the Dockerfile and run:

$ cd x86_64-unknown-linux-musl
$ ./build

At this point, subsequent uses of cross will now use your built image since Docker prefers local images over remote images. In order to make these changes stick, they need to be pushed to Docker Hub:

$ docker push burntsushi/cross:x86_64-unknown-linux-musl

Of course, only I (BurntSushi) can push to that location. To make cross use a different location, then edit Cross.toml in the root of this repo to use a different image name for the desired target.