From e8a234f658553927a2e845d64862321c90388e00 Mon Sep 17 00:00:00 2001
From: Jakob Unterwurzacher
Date: Wed, 6 Jul 2016 21:51:25 +0200
Subject: Add godoc comments to all internal packages

---
 internal/configfile/config_file.go  | 2 ++
 internal/contentenc/content.go      | 3 +--
 internal/cryptocore/cryptocore.go   | 2 ++
 internal/fusefrontend/fs.go         | 1 +
 internal/nametransform/names.go     | 3 +--
 internal/prefer_openssl/prefer.go   | 2 ++
 internal/readpassword/read.go       | 1 +
 internal/syscallcompat/sys_linux.go | 1 +
 internal/tlog/log.go                | 2 ++
 9 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/internal/configfile/config_file.go b/internal/configfile/config_file.go
index 95f4c6c..e27f2ad 100644
--- a/internal/configfile/config_file.go
+++ b/internal/configfile/config_file.go
@@ -1,3 +1,5 @@
+// Package configfile reads and writes gocryptfs.conf does the key
+// wrapping.
 package configfile
 
 import (
diff --git a/internal/contentenc/content.go b/internal/contentenc/content.go
index 6ac766f..493ec56 100644
--- a/internal/contentenc/content.go
+++ b/internal/contentenc/content.go
@@ -1,7 +1,6 @@
+// Package contentenc encrypts and decrypts file blocks.
 package contentenc
 
-// File content encryption / decryption
-
 import (
 	"bytes"
 	"encoding/binary"
diff --git a/internal/cryptocore/cryptocore.go b/internal/cryptocore/cryptocore.go
index 7e7f099..a9731be 100644
--- a/internal/cryptocore/cryptocore.go
+++ b/internal/cryptocore/cryptocore.go
@@ -1,3 +1,5 @@
+// Package cryptocore wraps OpenSSL and Go GCM crypto and provides
+// a nonce generator.
 package cryptocore
 
 import (
diff --git a/internal/fusefrontend/fs.go b/internal/fusefrontend/fs.go
index de168dc..5367622 100644
--- a/internal/fusefrontend/fs.go
+++ b/internal/fusefrontend/fs.go
@@ -1,3 +1,4 @@
+// Package fusefrontend interfaces directly with the go-fuse library.
 package fusefrontend
 
 // FUSE operations on paths
diff --git a/internal/nametransform/names.go b/internal/nametransform/names.go
index 89ce0db..8bebc25 100644
--- a/internal/nametransform/names.go
+++ b/internal/nametransform/names.go
@@ -1,7 +1,6 @@
+// Package namtransforms encrypts and decrypts filenames.
 package nametransform
 
-// Filename encryption / decryption functions
-
 import (
 	"crypto/aes"
 	"encoding/base64"
diff --git a/internal/prefer_openssl/prefer.go b/internal/prefer_openssl/prefer.go
index 81378a8..0afe7d5 100644
--- a/internal/prefer_openssl/prefer.go
+++ b/internal/prefer_openssl/prefer.go
@@ -1,3 +1,5 @@
+// Package prefer_openssl tries to determine if we should prefer openssl
+// on the platform we are running on.
 package prefer_openssl
 
 import (
diff --git a/internal/readpassword/read.go b/internal/readpassword/read.go
index 1b80f91..653868e 100644
--- a/internal/readpassword/read.go
+++ b/internal/readpassword/read.go
@@ -1,3 +1,4 @@
+// Package readpassword reads a password from the terminal of from stdin.
 package readpassword
 
 import (
diff --git a/internal/syscallcompat/sys_linux.go b/internal/syscallcompat/sys_linux.go
index 81cdb15..646dfc3 100644
--- a/internal/syscallcompat/sys_linux.go
+++ b/internal/syscallcompat/sys_linux.go
@@ -1,3 +1,4 @@
+// Package syscallcompat wraps Linux-specific syscalls.
 package syscallcompat
 
 import (
diff --git a/internal/tlog/log.go b/internal/tlog/log.go
index 254a207..a770df8 100644
--- a/internal/tlog/log.go
+++ b/internal/tlog/log.go
@@ -1,3 +1,5 @@
+// Package tlog is a "toggled logger" that can be enabled and disabled and
+// provides coloring.
 package tlog
 
 import (
-- 
cgit v1.2.3