github-mirror/mergerfs
2
0
Fork 0
mirror of https://github.com/trapexit/mergerfs.git synced 2024-11-22 11:02:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

README.md: request users update to latest version before they submit report

Browse Source
This commit is contained in:
Antonio SJ Musumeci 2020-04-20 09:15:04 -04:00
parent edb50e5411
commit eff15c72a5
2 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,6 +1,6 @@
% mergerfs(1) mergerfs user manual
% Antonio SJ Musumeci <trapexit@spawn.link>
% 2020-03-10
% 2020-04-20
# NAME
@ -338,7 +338,7 @@ The above behavior will help minimize the likelihood of EXDEV being returned but
The options `statfs` and `statfs_ignore` can be used to modify `statfs` behavior.
# BUILDING
# BUILD / UPDATE
**NOTE:** Prebuilt packages can be found at: https://github.com/trapexit/mergerfs/releases
@ -1129,7 +1129,9 @@ For non-Linux systems mergerfs uses a read-write lock and changes credentials on
# SUPPORT
Filesystems are very complex and difficult to debug. mergerfs, while being just a proxy of sorts, is also very difficult to debug given the large number of possible settings it can have itself and the massive number of environments it can run in. When reporting on a suspected issue **please, please** include as much of the below information as possible otherwise it will be difficult or impossible to diagnose. Also please make sure to read all of the above documentation as it includes nearly every known system or user issue previously encountered.
Filesystems are complex and difficult to debug. mergerfs, while being just a proxy of sorts, is also very difficult to debug given the large number of possible settings it can have itself and the massive number of environments it can run in. When reporting on a suspected issue **please, please** include as much of the below information as possible otherwise it will be difficult or impossible to diagnose. Also please make sure to read all of the above documentation as it includes nearly every known system or user issue previously encountered.
**Please make sure you are using the [latest release](https://github.com/trapexit/mergerfs/releases) or have tried it in comparison. Old versions, which are often included in distros like Debian and Ubuntu, are not ever going to be updated and your bug may have been addressed already.**
#### Information to include in bug reports
@ -1139,6 +1141,7 @@ Filesystems are very complex and difficult to debug. mergerfs, while being just
* Version of Linux: `uname -a`
* Versions of any additional software being used
* List of drives, their filesystems, and sizes (before and after issue): `df -h`
* **All** information about the relevant branches and paths: permissions, etc.
* A `strace` of the app having problems:
* `strace -f -o /tmp/app.strace.txt <cmd>`
* A `strace` of mergerfs while the program is trying to do whatever it's failing to do:

15
man/mergerfs.1
View File

@ -1,7 +1,7 @@
.\"t
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "mergerfs" "1" "2020\-03\-10" "mergerfs user manual" ""
.TH "mergerfs" "1" "2020\-04\-20" "mergerfs user manual" ""
.hy
.SH NAME
.PP
@ -860,7 +860,7 @@ included when checking the mount\[aq]s stats.
.PP
The options \f[C]statfs\f[] and \f[C]statfs_ignore\f[] can be used to
modify \f[C]statfs\f[] behavior.
.SH BUILDING
.SH BUILD / UPDATE
.PP
\f[B]NOTE:\f[] Prebuilt packages can be found at:
https://github.com/trapexit/mergerfs/releases
@ -2373,7 +2373,7 @@ This isn\[aq]t the best solution but should work reasonably well
assuming there are few users.
.SH SUPPORT
.PP
Filesystems are very complex and difficult to debug.
Filesystems are complex and difficult to debug.
mergerfs, while being just a proxy of sorts, is also very difficult to
debug given the large number of possible settings it can have itself and
the massive number of environments it can run in.
@ -2382,6 +2382,12 @@ much of the below information as possible otherwise it will be difficult
or impossible to diagnose.
Also please make sure to read all of the above documentation as it
includes nearly every known system or user issue previously encountered.
.PP
\f[B]Please make sure you are using the latest
release (https://github.com/trapexit/mergerfs/releases) or have tried it
in comparison. Old versions, which are often included in distros like
Debian and Ubuntu, are not ever going to be updated and your bug may
have been addressed already.\f[]
.SS Information to include in bug reports
.IP \[bu] 2
Version of mergerfs: \f[C]mergerfs\ \-V\f[]
@ -2395,6 +2401,9 @@ Versions of any additional software being used
List of drives, their filesystems, and sizes (before and after issue):
\f[C]df\ \-h\f[]
.IP \[bu] 2
\f[B]All\f[] information about the relevant branches and paths:
permissions, etc.
.IP \[bu] 2
A \f[C]strace\f[] of the app having problems:
.IP \[bu] 2
\f[C]strace\ \-f\ \-o\ /tmp/app.strace.txt\ <cmd>\f[]