Skip to contentSkip to conversation

doc: Add .min_swap_avail

PATCH In review Cyril Hrubis 2 participants 3 messages Sep 5, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: Add .min_swap_avail

---
 doc/c-test-api.txt              | 13 +++++++++----
 doc/test-writing-guidelines.txt |  1 +
 2 files changed, 10 insertions(+), 4 deletions(-)
doc/c-test-api.txt +9 -4
index f692909e2..373af0cd4 100644
@@ -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
 ~~~~~~~~~~~~~~
doc/test-writing-guidelines.txt +1 -0
index 6d1a69165..e2edc658a 100644
@@ -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' | –
Signature · 5 lines
2.41.0


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
#2 lore raw

Hi!
Pushed, thanks for the review.

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp