doc: Add .min_swap_avail

Signed-off-by: Cyril Hrubis <chrubis@suse.cz> Reviewed-by: Li Wang <liwang@redhat.com>
linux-test-project · Sep 5, 2023 · 310f063 · 310f063
1 parent fbed96c
commit 310f063
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/doc/c-test-api.txt b/doc/c-test-api.txt
@@ -2328,11 +2328,16 @@ both V1 and V2 feasible.
 Some tests require more than specific number of CPU. It can be defined with
 `.min_cpus = N`.
 
-1.39 Require minimum size of MemAvailable for a testcase
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1.39 Require minimum memory or swap size for a testcase
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some tests require at least size(MB) of free RAM or Swap.
+
+To make sure that test will run only on systems with more than minimal
+required amount of RAM set `.min_mem_avail = N`.
 
-Some tests require more than specific size(MB) of MemAvailable. It can be defined
-with `.min_mem_avail = N`.
+Similarily for tests that require certain amount of free Swap use
+`.min_swap_avail = N`.
 
 1.40 Test tags
 ~~~~~~~~~~~~~~

diff --git a/doc/test-writing-guidelines.txt b/doc/test-writing-guidelines.txt
@@ -370,6 +370,7 @@ https://github.com/linux-test-project/ltp/wiki/Shell-Test-API[Shell Test API].
 | '.min_kver' | 'TST_MIN_KVER'
 | '.min_mem_avail' | not applicable
 | '.mnt_flags' | 'TST_MNT_PARAMS'
+| '.min_swap_avail' | not applicable
 | '.mntpoint', '.mnt_data' | 'TST_MNTPOINT'
 | '.mount_device' | 'TST_MOUNT_DEVICE'
 | '.needs_cgroup_ctrls' | –