Commit 3d0c60d0 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: filesystems: convert ocfs2-online-filecheck.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/6007166acc3252697755836354bd29b5a5fb82aa.1581955849.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 461f2c8f
...@@ -76,6 +76,7 @@ Documentation for filesystem implementations. ...@@ -76,6 +76,7 @@ Documentation for filesystem implementations.
nilfs2 nilfs2
nfs/index nfs/index
ntfs ntfs
ocfs2-online-filecheck
overlayfs overlayfs
virtiofs virtiofs
vfat vfat
OCFS2 online file check .. SPDX-License-Identifier: GPL-2.0
-----------------------
=====================================
OCFS2 file system - online file check
=====================================
This document will describe OCFS2 online file check feature. This document will describe OCFS2 online file check feature.
...@@ -40,7 +43,7 @@ When there are errors in the OCFS2 filesystem, they are usually accompanied ...@@ -40,7 +43,7 @@ When there are errors in the OCFS2 filesystem, they are usually accompanied
by the inode number which caused the error. This inode number would be the by the inode number which caused the error. This inode number would be the
input to check/fix the file. input to check/fix the file.
There is a sysfs directory for each OCFS2 file system mounting: There is a sysfs directory for each OCFS2 file system mounting::
/sys/fs/ocfs2/<devname>/filecheck /sys/fs/ocfs2/<devname>/filecheck
...@@ -50,34 +53,36 @@ communicate with kernel space, tell which file(inode number) will be checked or ...@@ -50,34 +53,36 @@ communicate with kernel space, tell which file(inode number) will be checked or
fixed. Currently, three operations are supported, which includes checking fixed. Currently, three operations are supported, which includes checking
inode, fixing inode and setting the size of result record history. inode, fixing inode and setting the size of result record history.
1. If you want to know what error exactly happened to <inode> before fixing, do 1. If you want to know what error exactly happened to <inode> before fixing, do::
# echo "<inode>" > /sys/fs/ocfs2/<devname>/filecheck/check # echo "<inode>" > /sys/fs/ocfs2/<devname>/filecheck/check
# cat /sys/fs/ocfs2/<devname>/filecheck/check # cat /sys/fs/ocfs2/<devname>/filecheck/check
The output is like this: The output is like this::
INO DONE ERROR INO DONE ERROR
39502 1 GENERATION 39502 1 GENERATION
<INO> lists the inode numbers. <INO> lists the inode numbers.
<DONE> indicates whether the operation has been finished. <DONE> indicates whether the operation has been finished.
<ERROR> says what kind of errors was found. For the detailed error numbers, <ERROR> says what kind of errors was found. For the detailed error numbers,
please refer to the file linux/fs/ocfs2/filecheck.h. please refer to the file linux/fs/ocfs2/filecheck.h.
2. If you determine to fix this inode, do 2. If you determine to fix this inode, do::
# echo "<inode>" > /sys/fs/ocfs2/<devname>/filecheck/fix # echo "<inode>" > /sys/fs/ocfs2/<devname>/filecheck/fix
# cat /sys/fs/ocfs2/<devname>/filecheck/fix # cat /sys/fs/ocfs2/<devname>/filecheck/fix
The output is like this: The output is like this:::
INO DONE ERROR INO DONE ERROR
39502 1 SUCCESS 39502 1 SUCCESS
This time, the <ERROR> column indicates whether this fix is successful or not. This time, the <ERROR> column indicates whether this fix is successful or not.
3. The record cache is used to store the history of check/fix results. It's 3. The record cache is used to store the history of check/fix results. It's
default size is 10, and can be adjust between the range of 10 ~ 100. You can default size is 10, and can be adjust between the range of 10 ~ 100. You can
adjust the size like this: adjust the size like this::
# echo "<size>" > /sys/fs/ocfs2/<devname>/filecheck/set # echo "<size>" > /sys/fs/ocfs2/<devname>/filecheck/set
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment