Mirror
/
mergerfs
mirror of https://github.com/trapexit/mergerfs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #741 from trapexit/docs 

README.md: request users update to latest version before they submit …
pull/749/head
trapexit 5 years ago
committed by GitHub
parent
edb50e5411 eff15c72a5
commit
831dba3ef6
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 6 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 9
      README.md
  2. 15
      man/mergerfs.1

9
README.md
View File

@ -1,6 +1,6 @@
% mergerfs(1) mergerfs user manual % mergerfs(1) mergerfs user manual
% Antonio SJ Musumeci <trapexit@spawn.link> % Antonio SJ Musumeci <trapexit@spawn.link>
% 2020-03-10
% 2020-04-20
# NAME # 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. 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 **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 # 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 #### 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` * Version of Linux: `uname -a`
* Versions of any additional software being used * Versions of any additional software being used
* List of drives, their filesystems, and sizes (before and after issue): `df -h` * 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: * A `strace` of the app having problems:
* `strace -f -o /tmp/app.strace.txt <cmd>` * `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: * 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 .\"t
.\" Automatically generated by Pandoc 1.19.2.4 .\" 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 .hy
.SH NAME .SH NAME
.PP .PP
@ -860,7 +860,7 @@ included when checking the mount\[aq]s stats.
.PP .PP
The options \f[C]statfs\f[] and \f[C]statfs_ignore\f[] can be used to The options \f[C]statfs\f[] and \f[C]statfs_ignore\f[] can be used to
modify \f[C]statfs\f[] behavior. modify \f[C]statfs\f[] behavior.
.SH BUILDING
.SH BUILD / UPDATE
.PP .PP
\f[B]NOTE:\f[] Prebuilt packages can be found at: \f[B]NOTE:\f[] Prebuilt packages can be found at:
https://github.com/trapexit/mergerfs/releases 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. assuming there are few users.
.SH SUPPORT .SH SUPPORT
.PP .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 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 debug given the large number of possible settings it can have itself and
the massive number of environments it can run in. 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. or impossible to diagnose.
Also please make sure to read all of the above documentation as it Also please make sure to read all of the above documentation as it
includes nearly every known system or user issue previously encountered. 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 .SS Information to include in bug reports
.IP \[bu] 2 .IP \[bu] 2
Version of mergerfs: \f[C]mergerfs\ \-V\f[] 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): List of drives, their filesystems, and sizes (before and after issue):
\f[C]df\ \-h\f[] \f[C]df\ \-h\f[]
.IP \[bu] 2 .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: A \f[C]strace\f[] of the app having problems:
.IP \[bu] 2 .IP \[bu] 2
\f[C]strace\ \-f\ \-o\ /tmp/app.strace.txt\ <cmd>\f[] \f[C]strace\ \-f\ \-o\ /tmp/app.strace.txt\ <cmd>\f[]

Write Preview
Loading…
Cancel
Save