Merge branch 'stable-2.15'
* stable-2.15:
Improve LFS locks documentation
Change-Id: Ibf3e332b525619a43e1c5588ceecdc987b258658
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
index fdcee4c..6ad69fe 100644
--- a/src/main/resources/Documentation/config.md
+++ b/src/main/resources/Documentation/config.md
@@ -95,15 +95,13 @@
### Section `locks`
-locks.directory
-: The directory in which to store Git LFS file locks.
-[Git LFS File Locking API](https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md)
-specifies that certain path can be locked by user. It prevents from accidental file overwrite
-by different user and costly (manual in most cases) binary file merge.
-Each lock is represented by JSON structure:
+The [Git LFS File Locking API](https://github.com/git-lfs/git-lfs/blob/master/docs/api/locking.md)
+specifies that a certain path can be locked by a user. It prevents the file
+being accidentally overwritten by a different user, and costly (manual in
+most cases) binary file merge. Each lock is represented by a JSON structure:
```
- {
+ {
"id":"[lock id the same as lock file name]",
"path":"[path to the resource being locked]",
"locked_at":"[timestamp the lock was created in ISO 8601 format]",
@@ -113,7 +111,12 @@
}
```
-It is stored in a file with name computed as SHA256 of path being locked and is stored under `directory` followed by project name.
+The lock is stored in a file whose name is the SHA256 hash of the path being
+locked, under `locks.directory` followed by the project name.
+
+locks.directory
+: The directory in which to store Git LFS file locks.
+
: Default is `$GERRIT_SITE/data/@PLUGIN@/lfs_locks`.
### Section `auth`
