From 653ed1c775f0d66fadb7a3890cb1dfd2f0285553 Mon Sep 17 00:00:00 2001
From: Jakob Unterwurzacher
Date: Sat, 3 Feb 2018 13:27:53 +0100
Subject: Update compile page

Test output was out of date, and GOPATH is now usually
set to ~/go.
---
 docs/compile.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 53 insertions(+), 11 deletions(-)

(limited to 'docs/compile.md')

diff --git a/docs/compile.md b/docs/compile.md
index b79a0d4..67da722 100644
--- a/docs/compile.md
+++ b/docs/compile.md
@@ -12,32 +12,74 @@ On Debian and Ubuntu,
 
 	$ sudo apt-get install golang libssl-dev
 
-Also, GOPATH must be set. Usually it is simply set to the home directory:
+Also, `GOPATH` must be set. Usually it is set to the `go` folder in
+your home directory:
 
-	$ export GOPATH=~
+	$ export GOPATH=$HOME/go
 
 Download Source Code
 --------------------
 
+Download the gocryptfs source code and dependencies using `go get`:
+
 	$ go get -d github.com/rfjakob/gocryptfs
 
+And `cd` into the gocryptfs source directory:
+
+	$ cd $GOPATH/src/github.com/rfjakob/gocryptfs
+
 Compile
 -------
 
-	$ ~/src/github.com/rfjakob/gocryptfs/build.bash
+In the gocryptfs source directory, run:
 
-If successful, build.bash will copy the gocryptfs binary to ~/bin.
+	$ ./build.bash
+
+If successful, `build.bash` copies the `gocryptfs` binary to `~/bin`.
 
 Test
 ----
 
-	$ ~/src/github.com/rfjakob/gocryptfs/test.bash
+In the gocryptfs source directory, run:
 
-The tests run about 1 minute and should produce the following output:
+	$ ./test.bash
 
-	ok  	github.com/rfjakob/gocryptfs/cryptfs	1.174s
-	gocryptfs v0.7-15-gf01f599; on-disk format 2
-	ok  	github.com/rfjakob/gocryptfs/integration_tests	12.409s
+The tests run about 1 minute and should produce the following output:
 
-You can run "test.bash -v" to see the execution of individual tests. Note that
-the tests also check error cases that produce error messages.
+```
+gocryptfs v1.4.3-9-g9f8d0d8 without_openssl; go-fuse v20170619-28-g19acbd2; 2018-02-03 go1.9.2
+gocryptfs v1.4.3-9-g9f8d0d8; go-fuse v20170619-28-g19acbd2; 2018-02-03 go1.9.2
+ok  	github.com/rfjakob/gocryptfs	0.003s
+?   	github.com/rfjakob/gocryptfs/gocryptfs-xray	[no test files]
+ok  	github.com/rfjakob/gocryptfs/internal/configfile	0.732s
+ok  	github.com/rfjakob/gocryptfs/internal/contentenc	0.003s
+ok  	github.com/rfjakob/gocryptfs/internal/cryptocore	0.227s
+ok  	github.com/rfjakob/gocryptfs/internal/ctlsock	0.002s
+?   	github.com/rfjakob/gocryptfs/internal/exitcodes	[no test files]
+?   	github.com/rfjakob/gocryptfs/internal/fusefrontend	[no test files]
+?   	github.com/rfjakob/gocryptfs/internal/fusefrontend_reverse	[no test files]
+ok  	github.com/rfjakob/gocryptfs/internal/nametransform	0.003s
+?   	github.com/rfjakob/gocryptfs/internal/nametransform/dirivcache	[no test files]
+?   	github.com/rfjakob/gocryptfs/internal/openfiletable	[no test files]
+ok  	github.com/rfjakob/gocryptfs/internal/pathiv	0.003s
+ok  	github.com/rfjakob/gocryptfs/internal/prefer_openssl	0.003s
+ok  	github.com/rfjakob/gocryptfs/internal/readpassword	0.048s
+?   	github.com/rfjakob/gocryptfs/internal/serialize_reads	[no test files]
+ok  	github.com/rfjakob/gocryptfs/internal/siv_aead	0.005s
+ok  	github.com/rfjakob/gocryptfs/internal/speed	0.002s [no tests to run]
+ok  	github.com/rfjakob/gocryptfs/internal/stupidgcm	1.639s
+ok  	github.com/rfjakob/gocryptfs/internal/syscallcompat	0.027s
+?   	github.com/rfjakob/gocryptfs/internal/tlog	[no test files]
+ok  	github.com/rfjakob/gocryptfs/tests/cli	1.023s
+ok  	github.com/rfjakob/gocryptfs/tests/defaults	0.839s
+ok  	github.com/rfjakob/gocryptfs/tests/example_filesystems	4.076s
+ok  	github.com/rfjakob/gocryptfs/tests/hkdf_sanity	0.137s
+ok  	github.com/rfjakob/gocryptfs/tests/matrix	10.780s
+ok  	github.com/rfjakob/gocryptfs/tests/plaintextnames	0.089s
+ok  	github.com/rfjakob/gocryptfs/tests/reverse	0.854s
+?   	github.com/rfjakob/gocryptfs/tests/test_helpers	[no test files]
+```
+
+You can run `./test.bash -v` to see the execution of individual tests. Note that
+the tests also check error cases that produce error messages, and this is not
+a test failure.
-- 
cgit v1.2.3