@@ -79,33 +79,36 @@ $ make test-bytecomp
7979
8080#### Running the tests in Travis CI
8181
82- If you prefer to see the full Travis test suite run successfully, the easiest
82+ If you prefer to see the full Travis CI test suite run successfully, the easiest
8383way to achieve that is to create your own personal account on
84- https://travis-ci.org . View your profile details on the Travis site, and toggle
85- the switch to enable builds on your fork of the cider project.
84+ https://travis-ci.org . View your profile details on the Travis CI site, and
85+ toggle the switch to enable builds on your fork of the cider project.
8686
87- Subsequent pushes to your fork will generate a Travis build you can monitor for
88- success or failure.
87+ Subsequent pushes to your fork will generate a Travis CI build you can monitor
88+ for success or failure.
8989
90- #### Simulating the Travis tests locally in Docker
90+ #### Simulating the Travis CI tests locally in Docker
9191
92- If you prefer not to wait for Travis all the time, or if you need to debug
93- something that fails in Travis but does not fail for you on your own machine,
94- then you can also run the Travis tests manually in Docker.
92+ If you prefer not to wait for Travis CI all the time, or if you need to debug
93+ something that fails in Travis CI but does not fail for you on your own machine,
94+ then you can also run the Travis CI tests manually in Docker.
9595
9696You will need to run some scripts to build and launch the Docker image.
9797
9898To build:
99+
99100```
100101$ docker/build.sh
101102```
102103
103- The build script uses a base image provided by the engineers at Travis. Note: the
104- Travis docker image is currently more than 8GB, so be prepared with a good
105- internet connection and time to spare.
104+ The build script uses a base image provided by the engineers at Travis CI.
105+
106+ * Note: The Travis docker image is currently more than 8GB, so be prepared with a
107+ good internet connection and time to spare.*
106108
107109The resulting docker image is tagged simply ` cider-travis ` . You can run this
108110image by hand, but there is a convenience script available:
111+
109112```
110113$ docker/run.sh
111114```
@@ -114,20 +117,22 @@ This script launches a docker container and bind-mounts your cider project
114117directory as ` /home/travis/cider ` such that you can instantly see any code
115118changes reflected inside the docker environment.
116119
117- For instance, you can run tests on emacs 25.3
120+ For instance, first you can run tests on Emacs 25.3:
121+
118122```
119123(emacs-25.3-travis) ~/cider$ make test
120124```
121125
122- and then switch to emacs 26 and test again
126+ And then switch to Emacs 26.1 and test again:
123127
124128```
125- (emacs-25.3-travis) ~/cider$ evm use emacs -26-pretest-travis
129+ (emacs-25.3-travis) ~/cider$ evm use Emacs -26-pretest-travis
126130(emacs-26-pretest-travis) ~/cider$ cask install
127131(emacs-26-pretest-travis) ~/cider$ make test
128132```
129133
130134You can test byte compilation too
135+
131136```
132137(emacs-26-pretest-travis) ~/cider$ make test-bytecomp
133138```
@@ -138,9 +143,9 @@ container will also exit. Note that `docker/run.sh` runs the container with
138143container exits.
139144
140145So for example, by default, the docker image pre-installs only the most recent
141- releases of emacs 25, emacs 26, and a recent snapshot of the emacs git
146+ releases of Emacs 25, Emacs 26, and a recent snapshot of the Emacs git
142147repository. The ` evm ` tool is available should you need to install some other
143- specific build. However additional versions of emacs will be discarded when
148+ specific build. However additional versions of Emacs will be discarded when
144149you exit the docker container.
145150
146151## Hacking on cider-nrepl
0 commit comments