xref: /OK3568_Linux_fs/kernel/fs/ntfs/Kconfig (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyunconfig NTFS_FS
3*4882a593Smuzhiyun	tristate "NTFS file system support"
4*4882a593Smuzhiyun	select NLS
5*4882a593Smuzhiyun	help
6*4882a593Smuzhiyun	  NTFS is the file system of Microsoft Windows NT, 2000, XP and 2003.
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun	  Saying Y or M here enables read support.  There is partial, but
9*4882a593Smuzhiyun	  safe, write support available.  For write support you must also
10*4882a593Smuzhiyun	  say Y to "NTFS write support" below.
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun	  There are also a number of user-space tools available, called
13*4882a593Smuzhiyun	  ntfsprogs.  These include ntfsundelete and ntfsresize, that work
14*4882a593Smuzhiyun	  without NTFS support enabled in the kernel.
15*4882a593Smuzhiyun
16*4882a593Smuzhiyun	  This is a rewrite from scratch of Linux NTFS support and replaced
17*4882a593Smuzhiyun	  the old NTFS code starting with Linux 2.5.11.  A backport to
18*4882a593Smuzhiyun	  the Linux 2.4 kernel series is separately available as a patch
19*4882a593Smuzhiyun	  from the project web site.
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun	  For more information see <file:Documentation/filesystems/ntfs.rst>
22*4882a593Smuzhiyun	  and <http://www.linux-ntfs.org/>.
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun	  To compile this file system support as a module, choose M here: the
25*4882a593Smuzhiyun	  module will be called ntfs.
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun	  If you are not using Windows NT, 2000, XP or 2003 in addition to
28*4882a593Smuzhiyun	  Linux on your computer it is safe to say N.
29*4882a593Smuzhiyun
30*4882a593Smuzhiyunconfig NTFS_DEBUG
31*4882a593Smuzhiyun	bool "NTFS debugging support"
32*4882a593Smuzhiyun	depends on NTFS_FS
33*4882a593Smuzhiyun	help
34*4882a593Smuzhiyun	  If you are experiencing any problems with the NTFS file system, say
35*4882a593Smuzhiyun	  Y here.  This will result in additional consistency checks to be
36*4882a593Smuzhiyun	  performed by the driver as well as additional debugging messages to
37*4882a593Smuzhiyun	  be written to the system log.  Note that debugging messages are
38*4882a593Smuzhiyun	  disabled by default.  To enable them, supply the option debug_msgs=1
39*4882a593Smuzhiyun	  at the kernel command line when booting the kernel or as an option
40*4882a593Smuzhiyun	  to insmod when loading the ntfs module.  Once the driver is active,
41*4882a593Smuzhiyun	  you can enable debugging messages by doing (as root):
42*4882a593Smuzhiyun	  echo 1 > /proc/sys/fs/ntfs-debug
43*4882a593Smuzhiyun	  Replacing the "1" with "0" would disable debug messages.
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun	  If you leave debugging messages disabled, this results in little
46*4882a593Smuzhiyun	  overhead, but enabling debug messages results in very significant
47*4882a593Smuzhiyun	  slowdown of the system.
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun	  When reporting bugs, please try to have available a full dump of
50*4882a593Smuzhiyun	  debugging messages while the misbehaviour was occurring.
51*4882a593Smuzhiyun
52*4882a593Smuzhiyunconfig NTFS_RW
53*4882a593Smuzhiyun	bool "NTFS write support"
54*4882a593Smuzhiyun	depends on NTFS_FS
55*4882a593Smuzhiyun	help
56*4882a593Smuzhiyun	  This enables the partial, but safe, write support in the NTFS driver.
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun	  The only supported operation is overwriting existing files, without
59*4882a593Smuzhiyun	  changing the file length.  No file or directory creation, deletion or
60*4882a593Smuzhiyun	  renaming is possible.  Note only non-resident files can be written to
61*4882a593Smuzhiyun	  so you may find that some very small files (<500 bytes or so) cannot
62*4882a593Smuzhiyun	  be written to.
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun	  While we cannot guarantee that it will not damage any data, we have
65*4882a593Smuzhiyun	  so far not received a single report where the driver would have
66*4882a593Smuzhiyun	  damaged someones data so we assume it is perfectly safe to use.
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun	  Note:  While write support is safe in this version (a rewrite from
69*4882a593Smuzhiyun	  scratch of the NTFS support), it should be noted that the old NTFS
70*4882a593Smuzhiyun	  write support, included in Linux 2.5.10 and before (since 1997),
71*4882a593Smuzhiyun	  is not safe.
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun	  This is currently useful with TopologiLinux.  TopologiLinux is run
74*4882a593Smuzhiyun	  on top of any DOS/Microsoft Windows system without partitioning your
75*4882a593Smuzhiyun	  hard disk.  Unlike other Linux distributions TopologiLinux does not
76*4882a593Smuzhiyun	  need its own partition.  For more information see
77*4882a593Smuzhiyun	  <http://topologi-linux.sourceforge.net/>
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun	  It is perfectly safe to say N here.
80