Skip to contentSkip to conversation

include: Better documentation for TFAIL and TBROK\

PATCH In review Cyril Hrubis 4 participants 5 messages Sep 27, 2024 – Nov 1, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 include: Better documentation for TFAIL and TBROK\

Fixes #1162
---
 include/tst_res_flags.h | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)
include/tst_res_flags.h +19 -4
index 806940e0d..a79428fa2 100644
@@ -9,11 +9,26 @@
 /**
  * enum tst_res_flags - Test result reporting flags.
  *
- * @TPASS: Reports a single success.
- * @TFAIL: Reports a single failure.
- * @TBROK: Reports a single breakage.
+ * @TPASS: Reports a single success. Successes increment passed counter and
+ *         show up in the test results.
+ *
+ * @TFAIL: Reports a single failure. Failures increment failure counter and
+ *         show up in the test results. A failure occurs when test assertion
+ *         is broken.
+ *
+ * @TBROK: Reports a single breakage. Breakages increment breakage counter and
+ *         show up in the test results. Breakages are reported in cases where a
+ *         test couldn't be executed due to an unexpected failure when we were
+ *         setting the test environment. The TBROK status is mostly used
+ *         with tst_brk() which exit the test immediatelly. The difference
+ *         between TBROK and TCONF is that TCONF is used in cases where
+ *         optional functionality is missing while TBROK is used in cases where
+ *         something that is supposed to work is broken unexpectedly.
+ *
  * @TWARN: Reports a single warning. Warnings increment a warning counter and
- *         show up in test results.
+ *         show up in test results. Warnings are somewhere in the middle between
+ *         TBROK and TCONF. Warnings usually appear when something that is
+ *         supposed to be working is broken but the test can somehow continue.
  *
  * @TDEBUG: Prints additional debugging messages, it does not change the test result counters and
  *          the message is not displayed unless debugging is enabled with -D
Signature · 5 lines
2.44.2


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by on v1 1/1
#1 lore raw

Hi Cyril,

Quoted 3 lines · On Friday, September 27, 2024 12:18:13 PM GMT+2 Cyril Hrubis wrote:
Fixes #1162

Thank you,
Avinesh

Quoted 17 lines
---
 include/tst_res_flags.h | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)
include/tst_res_flags.h +2 -3
index 806940e0d..a79428fa2 100644
@@ -9,11 +9,26 @@
 /**
  * enum tst_res_flags - Test result reporting flags.
  *
- * @TPASS: Reports a single success.
- * @TFAIL: Reports a single failure.
- * @TBROK: Reports a single breakage.
+ * @TPASS: Reports a single success. Successes increment passed counter and
+ *         show up in the test results.

include/tst_res_flags.h line 23

Quoted 10 lines
include/tst_res_flags.h +10 -0
+ *
+ * @TFAIL: Reports a single failure. Failures increment failure counter and
+ *         show up in the test results. A failure occurs when test assertion
+ *         is broken.
+ *
+ * @TBROK: Reports a single breakage. Breakages increment breakage counter and
+ *         show up in the test results. Breakages are reported in cases where a
+ *         test couldn't be executed due to an unexpected failure when we were
+ *         setting the test environment. The TBROK status is mostly used
+ *         with tst_brk() which exit the test immediatelly. The difference

s/immediatelly/immediately

Quoted 13 lines
include/tst_res_flags.h +7 -1
+ *         between TBROK and TCONF is that TCONF is used in cases where
+ *         optional functionality is missing while TBROK is used in cases where
+ *         something that is supposed to work is broken unexpectedly.
+ *
  * @TWARN: Reports a single warning. Warnings increment a warning counter and
- *         show up in test results.
+ *         show up in test results. Warnings are somewhere in the middle between
+ *         TBROK and TCONF. Warnings usually appear when something that is
+ *         supposed to be working is broken but the test can somehow continue.
  *
  * @TDEBUG: Prints additional debugging messages, it does not change the test result counters and
  *          the message is not displayed unless debugging is enabled with -D
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by
#2 lore raw

Hi Cyril, Avinesh,

nit: there is trailing "\" in the test subject.

Quoted 29 lines

Hi Cyril,

Quoted 3 lines · On Friday, September 27, 2024 12:18:13 PM GMT+2 Cyril Hrubis wrote:
Fixes #1162

Thank you,
Avinesh

Quoted 17 lines
---
 include/tst_res_flags.h | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)
include/tst_res_flags.h +2 -3
index 806940e0d..a79428fa2 100644
@@ -9,11 +9,26 @@
 /**
  * enum tst_res_flags - Test result reporting flags.
  *
- * @TPASS: Reports a single success.
- * @TFAIL: Reports a single failure.
- * @TBROK: Reports a single breakage.
+ * @TPASS: Reports a single success. Successes increment passed counter and
+ *         show up in the test results.
Quoted 8 lines

include/tst_res_flags.h line 21

Quoted 8 lines
include/tst_res_flags.h +8 -0
+ *
+ * @TFAIL: Reports a single failure. Failures increment failure counter and
+ *         show up in the test results. A failure occurs when test assertion
+ *         is broken.
+ *
+ * @TBROK: Reports a single breakage. Breakages increment breakage counter and
+ *         show up in the test results. Breakages are reported in cases where a
+ *         test couldn't be executed due to an unexpected failure when we were

nit: maybe use passive form? "when we were setting the test environment" => "during the test setup" or "during setting the test environment"?

Quoted 3 lines

include/tst_res_flags.h line 23

Quoted 2 lines
include/tst_res_flags.h +2 -0
+ *         setting the test environment. The TBROK status is mostly used
+ *         with tst_brk() which exit the test immediatelly. The difference

s/immediatelly/immediately

+1

Quoted 3 lines

include/tst_res_flags.h line 26

Quoted 3 lines
include/tst_res_flags.h +3 -0
+ *         between TBROK and TCONF is that TCONF is used in cases where
+ *         optional functionality is missing while TBROK is used in cases where
+ *         something that is supposed to work is broken unexpectedly.

nit (not really sure): "that" => "which"

Quoted 5 lines

include/tst_res_flags.h line 30

Quoted 5 lines
include/tst_res_flags.h +3 -1
+ *
  * @TWARN: Reports a single warning. Warnings increment a warning counter and
- *         show up in test results.
+ *         show up in test results. Warnings are somewhere in the middle between
+ *         TBROK and TCONF. Warnings usually appear when something that is

nit (not really sure): "that" => "which"

Kind regards,
Petr

Quoted 1 line
Quoted 1 line
include/tst_res_flags.h +1 -0
+ *         supposed to be working is broken but the test can somehow continue.
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by Wei Gao
#3 lore raw
Quoted 60 lines · Petr Vorel

Hi Cyril, Avinesh,

nit: there is trailing "\" in the test subject.

Quoted 29 lines

Hi Cyril,

Quoted 3 lines · On Friday, September 27, 2024 12:18:13 PM GMT+2 Cyril Hrubis wrote:
Fixes #1162

Thank you,
Avinesh

Quoted 17 lines
---
 include/tst_res_flags.h | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)
include/tst_res_flags.h +2 -3
index 806940e0d..a79428fa2 100644
@@ -9,11 +9,26 @@
 /**
  * enum tst_res_flags - Test result reporting flags.
  *
- * @TPASS: Reports a single success.
- * @TFAIL: Reports a single failure.
- * @TBROK: Reports a single breakage.
+ * @TPASS: Reports a single success. Successes increment passed counter and
+ *         show up in the test results.
Quoted 8 lines

include/tst_res_flags.h line 21

Quoted 8 lines
include/tst_res_flags.h +8 -0
+ *
+ * @TFAIL: Reports a single failure. Failures increment failure counter and
+ *         show up in the test results. A failure occurs when test assertion
+ *         is broken.
+ *
+ * @TBROK: Reports a single breakage. Breakages increment breakage counter and
+ *         show up in the test results. Breakages are reported in cases where a
+ *         test couldn't be executed due to an unexpected failure when we were

nit: maybe use passive form? "when we were setting the test environment" => "during the test setup" or "during setting the test environment"?

Quoted 3 lines

include/tst_res_flags.h line 23

Quoted 2 lines
include/tst_res_flags.h +2 -0
+ *         setting the test environment. The TBROK status is mostly used
+ *         with tst_brk() which exit the test immediatelly. The difference

s/immediatelly/immediately

+1

Quoted 3 lines

include/tst_res_flags.h line 26

Quoted 3 lines
include/tst_res_flags.h +3 -0
+ *         between TBROK and TCONF is that TCONF is used in cases where
+ *         optional functionality is missing while TBROK is used in cases where
+ *         something that is supposed to work is broken unexpectedly.

nit (not really sure): "that" => "which"

Quoted 5 lines

include/tst_res_flags.h line 30

Quoted 5 lines
include/tst_res_flags.h +3 -1
+ *
  * @TWARN: Reports a single warning. Warnings increment a warning counter and
- *         show up in test results.
+ *         show up in test results. Warnings are somewhere in the middle between
+ *         TBROK and TCONF. Warnings usually appear when something that is
Quoted 8 lines

nit (not really sure): "that" => "which"

Kind regards,
Petr

Quoted 1 line
Quoted 1 line
include/tst_res_flags.h +1 -0
+ *         supposed to be working is broken but the test can somehow continue.
Quoted 3 lines
Signature · 2 lines
-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#4 lore raw
In reply to Petr Vorel

Hi!

Quoted 1 line

nit: there is trailing "\" in the test subject.

I know, fixed.

Quoted 15 lines
Quoted 15 lines
Quoted 15 lines
include/tst_res_flags.h +4 -3
index 806940e0d..a79428fa2 100644
@@ -9,11 +9,26 @@
 /**
  * enum tst_res_flags - Test result reporting flags.
  *
- * @TPASS: Reports a single success.
- * @TFAIL: Reports a single failure.
- * @TBROK: Reports a single breakage.
+ * @TPASS: Reports a single success. Successes increment passed counter and
+ *         show up in the test results.
+ *
+ * @TFAIL: Reports a single failure. Failures increment failure counter and
Quoted 8 lines
Quoted 6 lines

include/tst_res_flags.h line 21

Quoted 6 lines
include/tst_res_flags.h +6 -0
+ *         show up in the test results. A failure occurs when test assertion
+ *         is broken.
+ *
+ * @TBROK: Reports a single breakage. Breakages increment breakage counter and
+ *         show up in the test results. Breakages are reported in cases where a
+ *         test couldn't be executed due to an unexpected failure when we were

nit: maybe use passive form? "when we were setting the test environment" => "during the test setup" or "during setting the test environment"?

That is indeed better, thanks.

Quoted 5 lines
Quoted 3 lines

include/tst_res_flags.h line 23

Quoted 2 lines
include/tst_res_flags.h +2 -0
+ *         setting the test environment. The TBROK status is mostly used
+ *         with tst_brk() which exit the test immediatelly. The difference

s/immediatelly/immediately

+1

Fixed as well.

Quoted 11 lines
Quoted 3 lines

include/tst_res_flags.h line 26

Quoted 3 lines
include/tst_res_flags.h +3 -0
+ *         between TBROK and TCONF is that TCONF is used in cases where
+ *         optional functionality is missing while TBROK is used in cases where
+ *         something that is supposed to work is broken unexpectedly.

nit (not really sure): "that" => "which"

Quoted 5 lines

include/tst_res_flags.h line 30

Quoted 5 lines
include/tst_res_flags.h +3 -1
+ *
  * @TWARN: Reports a single warning. Warnings increment a warning counter and
- *         show up in test results.
+ *         show up in test results. Warnings are somewhere in the middle between
+ *         TBROK and TCONF. Warnings usually appear when something that is

nit (not really sure): "that" => "which"

AFAIK both can work here, so I kept the original.

Thanks a lot everyone for the reviews, pushed.

Signature · 5 lines
Cyril Hrubis
[email protected]

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