[thirdparty/xfsprogs-dev.git] / doc / README-env-vars.txt

Several environment variables are used within the code, primarily for
for debugging purposes; they are documented here.  In most cases simply
setting the environment variable enables the behavior, but in some
cases the value assigned influences behavior as well, as noted below.

General
-------
LIBXFS_LEAK_CHECK            -- warn and exit(1) if zone-allocated memory
                                is leaked at exit.
xfs_fsr
-------
FSRXFSTEST                   -- enable -C nfrag in theory coalesces into
                                nfrag extents.  Doesn't work.
xfs_scrub
---------
Known debug tweaks (pass -d and set the environment variable):
XFS_SCRUB_FORCE_ERROR        -- pretend all metadata is corrupt
XFS_SCRUB_FORCE_REPAIR       -- repair all metadata even if it's ok
XFS_SCRUB_NO_KERNEL          -- pretend there is no kernel ioctl
XFS_SCRUB_NO_SCSI_VERIFY     -- disable SCSI VERIFY (if present)
XFS_SCRUB_PHASE              -- run only this scrub phase
XFS_SCRUB_THREADS            -- start exactly this number of threads

Available even in non-debug mode:
SERVICE_MODE                 -- compress all error codes to 1 for LSB
                                service action compliance
Commit	Line	Data
669be3c4 ES	1	Several environment variables are used within the code, primarily for
	2	for debugging purposes; they are documented here. In most cases simply
	3	setting the environment variable enables the behavior, but in some
	4	cases the value assigned influences behavior as well, as noted below.
	5
	6	General
	7	-------
	8	LIBXFS_LEAK_CHECK -- warn and exit(1) if zone-allocated memory
	9	is leaked at exit.
	10	xfs_fsr
	11	-------
	12	FSRXFSTEST -- enable -C nfrag in theory coalesces into
	13	nfrag extents. Doesn't work.
	14	xfs_scrub
	15	---------
	16	Known debug tweaks (pass -d and set the environment variable):
	17	XFS_SCRUB_FORCE_ERROR -- pretend all metadata is corrupt
	18	XFS_SCRUB_FORCE_REPAIR -- repair all metadata even if it's ok
	19	XFS_SCRUB_NO_KERNEL -- pretend there is no kernel ioctl
	20	XFS_SCRUB_NO_SCSI_VERIFY -- disable SCSI VERIFY (if present)
	21	XFS_SCRUB_PHASE -- run only this scrub phase
	22	XFS_SCRUB_THREADS -- start exactly this number of threads
	23
	24	Available even in non-debug mode:
	25	SERVICE_MODE -- compress all error codes to 1 for LSB
	26	service action compliance