From cef5a703ea0a6af88577880fae7ad1dc452e3ea0 Mon Sep 17 00:00:00 2001 From: Tyler Treat Date: Thu, 1 Jun 2017 17:08:54 -0500 Subject: [PATCH] Add Development section to README Add a note clarifying symlink behavior on Windows for developers. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 5ec5836f..56d2f155 100644 --- a/README.md +++ b/README.md @@ -650,6 +650,30 @@ For example, running the `gnatsd -m 8222` command, you should see that the NATS [83249] 2016/06/23 19:39:35.175226 [INF] Server is ready ``` +## Development + +This section contains notes for those looking to do development on gnatsd. + +### Windows + +Some unit tests make use of temporary symlinks for testing purposes. On Windows, this can fail due to insufficient privileges: + +``` +--- FAIL: TestConfigReload (0.00s) + reload_test.go:175: Error creating symlink: symlink .\configs\reload\test.conf g:\src\github.com\nats-io\gnatsd\server\tmp.conf: A required privilege is not held by the client. +FAIL +``` + +Similarly, this can fail when creating a symlink on a network drive, which is typically now allowed by default: + +``` +--- FAIL: TestConfigReload (0.00s) + reload_test.go:175: Error creating symlink: symlink .\configs\reload\test.conf g:\src\github.com\nats-io\gnatsd\server\tmp.conf: Incorrect function. +FAIL +``` + +If this is the case, ensure that the tests are run with privileges on a local drive (e.g. running on `C:` as admin). + ## License (The MIT License)