Merge pull request #817 from trapexit/readme

README.md: add note indicating only tagged releases are supported

README.md

@@ -1,6 +1,6 @@
 % mergerfs(1) mergerfs user manual
 % Antonio SJ Musumeci <trapexit@spawn.link>
-% 2020-08-20
+% 2020-08-26
 
 # NAME
 
@@ -412,7 +412,8 @@ The options `statfs` and `statfs_ignore` can be used to modify `statfs` behavior
 
 # BUILD / UPDATE
 
-**NOTE:** Prebuilt packages can be found at: https://github.com/trapexit/mergerfs/releases
+**NOTE:** Prebuilt packages can be found at and recommended for most users: https://github.com/trapexit/mergerfs/releases
+**NOTE:** Only tagged releases are supported. `master` and other branches should be considered works in progress.
 
 First get the code from [github](https://github.com/trapexit/mergerfs).
 

man/mergerfs.1

@@ -1,7 +1,7 @@
 .\"t
 .\" Automatically generated by Pandoc 1.19.2.4
 .\"
-.TH "mergerfs" "1" "2020\-08\-20" "mergerfs user manual" ""
+.TH "mergerfs" "1" "2020\-08\-26" "mergerfs user manual" ""
 .hy
 .SH NAME
 .PP
@@ -736,8 +736,8 @@ _
 T{
 all
 T}@T{
-Search: same as \f[B]epall\f[].
-Action: same as \f[B]epall\f[].
+Search: Same as \f[B]epall\f[].
+Action: Same as \f[B]epall\f[].
 Create: for \f[B]mkdir\f[], \f[B]mknod\f[], and \f[B]symlink\f[] it will
 apply to all branches.
 \f[B]create\f[] works like \f[B]ff\f[].
@@ -745,7 +745,7 @@ T}
 T{
 epall (existing path, all)
 T}@T{
-Search: same as \f[B]epff\f[] (but more expensive because it doesn\[aq]t
+Search: Same as \f[B]epff\f[] (but more expensive because it doesn\[aq]t
 stop after finding a valid branch).
 Action: apply to all found.
 Create: for \f[B]mkdir\f[], \f[B]mknod\f[], and \f[B]symlink\f[] it will
@@ -797,61 +797,61 @@ T}
 T{
 ff (first found)
 T}@T{
-Search: same as \f[B]epff\f[].
-Action: same as \f[B]epff\f[].
+Search: Same as \f[B]epff\f[].
+Action: Same as \f[B]epff\f[].
 Create: Given the order of the drives, as defined at mount time or
 configured at runtime, act on the first one found.
 T}
 T{
 lfs (least free space)
 T}@T{
-Search: same as \f[B]eplfs\f[].
-Action: same as \f[B]eplfs\f[].
+Search: Same as \f[B]eplfs\f[].
+Action: Same as \f[B]eplfs\f[].
 Create: Pick the drive with the least available free space.
 T}
 T{
 lus (least used space)
 T}@T{
-Search: same as \f[B]eplus\f[].
-Action: same as \f[B]eplus\f[].
+Search: Same as \f[B]eplus\f[].
+Action: Same as \f[B]eplus\f[].
 Create: Pick the drive with the least used space.
 T}
 T{
 mfs (most free space)
 T}@T{
-Search: same as \f[B]epmfs\f[].
-Action: same as \f[B]epmfs\f[].
+Search: Same as \f[B]epmfs\f[].
+Action: Same as \f[B]epmfs\f[].
 Create: Pick the drive with the most available free space.
 T}
 T{
 msplfs (most shared path, least free space)
 T}@T{
-Search: same as \f[B]eplfs\f[].
-Action: same as \f[B]eplfs\f[].
+Search: Same as \f[B]eplfs\f[].
+Action: Same as \f[B]eplfs\f[].
 Create: like \f[B]eplfs\f[] but walk back the path if it fails to find a
 branch at that level.
 T}
 T{
 msplus (most shared path, least used space)
 T}@T{
-Search: same as \f[B]eplus\f[].
-Action: same as \f[B]eplus\f[].
+Search: Same as \f[B]eplus\f[].
+Action: Same as \f[B]eplus\f[].
 Create: like \f[B]eplus\f[] but walk back the path if it fails to find a
 branch at that level.
 T}
 T{
 mspmfs (most shared path, most free space)
 T}@T{
-Search: same as \f[B]epmfss\f[].
-Action: same as \f[B]epmfs\f[].
+Search: Same as \f[B]epmfss\f[].
+Action: Same as \f[B]epmfs\f[].
 Create: like \f[B]eplmfs\f[] but walk back the path if it fails to find
 a branch at that level.
 T}
 T{
 msppfrd (most shared path, percentage free random distribution)
 T}@T{
-Search: same as \f[B]eppfrd\f[].
-Action: same as \f[B]eppfrd\f[].
+Search: Same as \f[B]eppfrd\f[].
+Action: Same as \f[B]eppfrd\f[].
 Create: Like \f[B]eppfrd\f[] but will walk back the path if it fails to
 find a branch at that level.
 T}
@@ -863,8 +863,8 @@ T}
 T{
 pfrd (percentage free random distribution)
 T}@T{
-Search: same as \f[B]eppfrd\f[].
-Action: same as \f[B]eppfrd\f[].
+Search: Same as \f[B]eppfrd\f[].
+Action: Same as \f[B]eppfrd\f[].
 Create: Chooses a branch at random with the likelihood of selection
 based on a branch\[aq]s available space relative to the total.
 T}
@@ -1077,8 +1077,11 @@ The options \f[C]statfs\f[] and \f[C]statfs_ignore\f[] can be used to
 modify \f[C]statfs\f[] behavior.
 .SH BUILD / UPDATE
 .PP
-\f[B]NOTE:\f[] Prebuilt packages can be found at:
-https://github.com/trapexit/mergerfs/releases
+\f[B]NOTE:\f[] Prebuilt packages can be found at and recommended for
+most users: https://github.com/trapexit/mergerfs/releases \f[B]NOTE:\f[]
+Only tagged releases are supported.
+\f[C]master\f[] and other branches should be considered works in
+progress.
 .PP
 First get the code from github (https://github.com/trapexit/mergerfs).
 .IP