Skip to content

Commit 58cd33c

Browse files
committed
Cleanup readme and some settings
1 parent 95b73b0 commit 58cd33c

File tree

6 files changed

+9
-134
lines changed

6 files changed

+9
-134
lines changed

.gitignore

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
1-
.dialyzer.raw-output
21
.eunit/*
32
deps/*
43
rel/riak-cs
54
rel/vars/dev*_vars.config
6-
ebin/*.beam
7-
ebin/*.app
5+
ebin/*
86
riak_test/ebin/*
9-
riak_test/bin/riak-cs*
107
doc
118
dev/
129
/package/
1310
log/
1411
*~
15-
/log
1612
current_counterexample.eqc
17-
.int_test/
1813
.client_test/
1914
pkg.vars.config
2015
client_tests/python/ceph_tests/s3-tests

.travis.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

Makefile

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
REPO ?= riak_cs
1+
REPO ?= riak_cs
22
PKG_REVISION ?= $(shell git describe --tags)
3-
PKG_VERSION ?= $(shell git describe --tags | tr - .)
3+
PKG_VERSION ?= $(shell git describe --tags | tr - .)
44
PKG_ID = riak-cs-$(PKG_VERSION)
55
PKG_BUILD = 1
66
BASE_DIR = $(shell pwd)
77
ERLANG_BIN = $(shell dirname $(shell which erl))
88
REBAR ?= $(BASE_DIR)/rebar
99
OVERLAY_VARS ?=
1010
CS_HTTP_PORT ?= 8080
11-
PULSE_TESTS = riak_cs_get_fsm_pulse
11+
PULSE_TESTS = riak_cs_get_fsm_pulse
1212

1313
.PHONY: rel stagedevrel deps test depgraph graphviz all compile
1414

@@ -154,18 +154,6 @@ stage : rel
154154
$(foreach dep,$(wildcard deps/*), rm -rf rel/riak-cs/lib/$(shell basename $(dep))* && ln -sf $(abspath $(dep)) rel/riak-cs/lib;)
155155

156156

157-
##
158-
## Doc targets
159-
##
160-
orgs: orgs-doc orgs-README
161-
162-
orgs-doc:
163-
@emacs -l orgbatch.el -batch --eval="(riak-export-doc-dir \"doc\" 'html)"
164-
165-
orgs-README:
166-
@emacs -l orgbatch.el -batch --eval="(riak-export-doc-file \"README.org\" 'ascii)"
167-
@mv README.txt README
168-
169157
DIALYZER_APPS = kernel stdlib sasl erts ssl tools os_mon runtime_tools crypto inets \
170158
webtool eunit syntax_tools compiler
171159
PLT ?= $(HOME)/.riak-cs_dialyzer_plt

README.multi-backend.txt

Lines changed: 0 additions & 80 deletions
This file was deleted.

README.org

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ with Riak CS. For more information about Riak CS please visit our [[http://docs.
7878

7979
* Riak CS Fast Track
8080

81-
http://docs.basho.com/riakcs/latest/riakcs-tutorials/fast-track
81+
http://docs.basho.com/riakcs/latest/tutorials/fast-track/
8282

8383
* Contributing to Riak CS
8484
Basho encourages contributions to Riak CS from the community. Here is
@@ -134,33 +134,12 @@ make test
134134
rebuilding the PLT unless you have had significant changes in your
135135
build (a new version of Erlang, for example).
136136

137-
**** Build the PLT
138-
Run the command below to build the PLT.
139-
140-
#+BEGIN_SRC shell
141-
make build_plt
142-
#+END_SRC
143-
144-
**** Check the PLT
145-
If you have built the PLT before, check it before you run
146-
Dialyzer again. This will take much less time than building the
147-
PLT from scratch.
148-
149-
#+BEGIN_SRC shell
150-
make check_plt
151-
#+END_SRC
152-
153-
**** Run Dialyzer
137+
Dialyzer can be run with =make=:
154138

155139
#+BEGIN_SRC shell
156140
make dialyzer
157141
#+END_SRC
158142

159143
*** =riak_test= modules
160144
Riak CS has a number of integration and regression tests in the
161-
=/riak_test/= subdirectory. Currently these tests require the
162-
enterprise versions of Riak and Riak CS to function properly, but
163-
they will be updated the near future to support running an
164-
appropriate subset with an OSS build of Riak and Riak
165-
CS. Instructions for setting up and running the tests will also be
166-
published at that time.
145+
=/riak_test/= subdirectory. Please refer =README.md= under the directory.

riak_test/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Example to setup old and new CS:
1414
$ mkdir ~/rt
1515
$ cd ~/rt
1616
$ cd path/to/repo/riak_cs
17+
## Only for Enterprise build
1718
$ export RIAK_CS_EE_DEPS=true
1819
$ riak_test/bin/rtdev-build-releases.sh
1920
$ riak_test/bin/rtdev-setup-releases.sh
@@ -42,7 +43,7 @@ $ cd riak-ee-2.0.1 && make devrel
4243
$ riak_test/bin/rteedev-setup-releases.sh
4344
$ riak_test/bin/rteedev-current.sh
4445
45-
## ch runtime to Basho's patched R15B01
46+
## change runtime to Basho's patched R15B01
4647
$ tar xzf riak-ee-1.4.10.tar.gz
4748
$ cd riak-ee-1.4.10 && make devrel
4849
$ mkdir ~/rt/riak_ee/riak-ee-1.4.10

0 commit comments

Comments
 (0)