mirror of
https://github.com/koverstreet/bcachefs-tools.git
synced 2025-12-08 00:00:12 +03:00
Merge pull request #466 from a4blue/documentation-braindump
Some checks failed
build / bcachefs-tools-msrv (push) Has been cancelled
.deb build orchestrator / source-only (push) Has been cancelled
.deb build orchestrator / obs (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:forky], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:forky], map[build-arch:amd64 host-arch:ppc64el machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:forky], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:trixie], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:trixie], map[build-arch:amd64 host-arch:ppc64el machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:trixie], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:unstable], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:unstable], map[build-arch:amd64 host-arch:ppc64el machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:unstable], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:plucky], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:plucky], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:questing], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:questing], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / reprotest (push) Has been cancelled
.deb build orchestrator / publish (push) Has been cancelled
Nix Flake actions / nix-matrix (push) Has been cancelled
Nix Flake actions / ${{ matrix.name }} (${{ matrix.system }}) (push) Has been cancelled
Some checks failed
build / bcachefs-tools-msrv (push) Has been cancelled
.deb build orchestrator / source-only (push) Has been cancelled
.deb build orchestrator / obs (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:forky], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:forky], map[build-arch:amd64 host-arch:ppc64el machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:forky], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:trixie], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:trixie], map[build-arch:amd64 host-arch:ppc64el machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:trixie], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:unstable], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:unstable], map[build-arch:amd64 host-arch:ppc64el machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:debian version:unstable], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:plucky], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:plucky], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:questing], map[build-arch:amd64 host-arch:amd64 machine-arch:amd64 runs-on:ubuntu-24.04]) (push) Has been cancelled
.deb build orchestrator / buildd (map[name:ubuntu version:questing], map[build-arch:arm64 host-arch:arm64 machine-arch:arm64 runs-on:ubuntu-24.04-arm]) (push) Has been cancelled
.deb build orchestrator / reprotest (push) Has been cancelled
.deb build orchestrator / publish (push) Has been cancelled
Nix Flake actions / nix-matrix (push) Has been cancelled
Nix Flake actions / ${{ matrix.name }} (${{ matrix.system }}) (push) Has been cancelled
Documentation updates
This commit is contained in:
commit
4ef1c8dba0
@ -530,7 +530,8 @@ filesystem:
|
||||
\item \texttt{bcachefs device add}: Formats and adds a new device to an
|
||||
existing filesystem.
|
||||
\item \texttt{bcachefs device remove}: Permanently removes a device from
|
||||
an existing filesystem.
|
||||
an existing filesystem. Offline Devices can be removed via ID found
|
||||
in Superblock
|
||||
\item \texttt{bcachefs device online}: Connects a device to a running
|
||||
filesystem that was mounted without it (i.e. in degraded mode)
|
||||
\item \texttt{bcachefs device offline}: Disconnects a device from a
|
||||
@ -540,6 +541,7 @@ filesystem:
|
||||
if necessary.
|
||||
\item \texttt{bcachefs device set-state}: Changes the state of a member
|
||||
device: one of rw (readwrite), ro (readonly), failed, or spare.
|
||||
Offline Devices can be removed via ID found in Superblock
|
||||
|
||||
A failed device is considered to have 0 durability, and replicas
|
||||
on that device won't be counted towards the number of replicas
|
||||
@ -552,6 +554,10 @@ The \texttt{bcachefs device remove}, \texttt{bcachefs device offline} and
|
||||
would leave the filesystem degraded or with data missing. Todo: regularize and
|
||||
improve those options.
|
||||
|
||||
\subsubsection{Device labeling}
|
||||
Devices can be labeled after Formatting by setting \\
|
||||
\texttt{/sys/fs/bcachefs/<uuid>/dev-<device-id>/label}
|
||||
|
||||
\subsection{Data management}
|
||||
|
||||
\subsubsection{Data rereplicate}
|
||||
@ -571,8 +577,10 @@ a third device added.
|
||||
|
||||
\subsubsection{Scrub}
|
||||
|
||||
To be implemented: a command for reading all data within a filesystem and
|
||||
ensuring that checksums are valid, fixing bitrot when a valid copy can be found.
|
||||
The \texttt{bcachefs data scrub} Command takes a mountpoint as first parameter and
|
||||
validates all data with checksums, fixing bitrot when a valid copy can be found.
|
||||
Currently does not print affected files in the Terminal, but when a broken File is
|
||||
found the path is being printed into the Kernel Log.
|
||||
|
||||
\section{Options}
|
||||
|
||||
@ -581,7 +589,8 @@ also be set on inodes (files and directories), overriding the global defaults.
|
||||
Filesystem wide options may be set when formatting, when mounting, or at runtime
|
||||
via \texttt{/sys/fs/bcachefs/<uuid>/options/}. When set at runtime via sysfs,
|
||||
the persistent options in the superblock are updated as well; when options are
|
||||
passed as mount parameters the persistent options are unmodified.
|
||||
passed as mount parameters the persistent options are unmodified. Additionally
|
||||
some of the filesystem wide options can be set via \texttt{bcachefs set-fs-option}
|
||||
|
||||
\subsection{File and directory options}
|
||||
|
||||
@ -731,6 +740,9 @@ recursively.
|
||||
|
||||
\texttt{discard} \` \textbf{device} \\
|
||||
\> Enable discard/TRIM support \\ \\
|
||||
|
||||
\texttt{casefold\_disabled} \` \textbf{mount} \\
|
||||
\> Disables the Casefolding Feature \\ \\
|
||||
\end{tabbing}
|
||||
|
||||
\subsection{Error actions}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user