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