Subtest documentation
v4 cover Subtest documentation
Changes:
1/5 Fix a brainfart that I thought I tested for. Thanks, CI!
Petri Latvala (5):
Add support for subtest-specific documentation
README: Describe the subtest documentation command line flags
docs: Include subtest documentation
testdisplay: Handle subtest documentation flags igt_command_line.sh: Test subtest documentation flag handling
README | 5 + docs/reference/intel-gpu-tools/Makefile.am | 6 ++ lib/igt_aux.c | 8 +- lib/igt_core.c | 149 +++++++++++++++++++++++------ lib/igt_core.h | 6 +- tests/igt_command_line.sh | 12 ++- tests/testdisplay.c | 2 + 7 files changed, 152 insertions(+), 36 deletions(-)
Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
PATCH v4 1/5 Add support for subtest-specific documentation
The current documentation for tests is limited to a single string per test binary. This patch adds support for documenting individual subtests.
The syntax for subtest documentation is:
igt_document_subtest("Frob knobs to see if one of the "
"crossbeams will go out of skew on the " "treadle.\n");
igt_subtest("knob-frobbing-askew")
test_frob();
or with a format string:
for_example_loop(e) {
igt_document_subtest_f("Frob %s to see if one of the "
"crossbeams will go out of skew on the "
"treadle.\n", e->readable_name);
igt_subtest_f("%s-frob-askew", e->name)
test_frob(e);
}The documentation cannot be extracted from just comments, because associating them with the correct subtest name will then require doing pattern matching in the documentation generator, for subtests where the name is generated at runtime using igt_subtest_f.
v2: Rebase, change function name in commit message to match code
v3: Fix current documentation string tracking, add missing va_end (Vinay)
v4: Fix brainfart in __igt_run_subtest
--- lib/igt_aux.c | 8 ++-- lib/igt_core.c | 149 +++++++++++++++++++++++++++++++++++++++++++++------------ lib/igt_core.h | 6 ++- 3 files changed, 128 insertions(+), 35 deletions(-)
lib/igt_aux.c +4 -4
@@ -311,7 +311,7 @@ static void sig_handler(int i)*/ void igt_fork_signal_helper (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;/* We pick SIGCONT as it is a "safe" signal - if we send SIGCONT to
@@ -344,7 +344,7 @@ void igt_fork_signal_helper(void)*/ void igt_stop_signal_helper (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;igt_stop_helper (&signal_helper);
@@ -375,7 +375,7 @@ static void __attribute__((noreturn)) shrink_helper_process(int fd, pid_t pid)*/ void igt_fork_shrink_helper (int drm_fd) { -assert (!igt_only_list_subtests ()); +assert (!igt_only_collect_data ());igt_require (igt_drop_caches_has (drm_fd,DROP_SHRINK_ALL )); igt_fork_helper(&shrink_helper)shrink_helper_process (drm_fd,getppid ());
@@ -473,7 +473,7 @@ void igt_stop_hang_detector(void)#else void igt_fork_hang_detector (int fd) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ; }
lib/igt_core.c +119 -30
283 lines not on this page · raw message
lib/igt_core.h +5 -1
@@ -197,8 +197,12 @@ bool __igt_run_subtest(const char *subtest_name); #define igt_subtest_f(f...) \ __igt_subtest_f(igt_tokencat(__tmpchar, __LINE__), f) +void igt_document_subtest (const char *documentation); +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...); +const char *igt_subtest_name (void ); -bool igt_only_list_subtests (void ); +bool igt_only_collect_data (void );void __igt_subtest_group_save (int *);void __igt_subtest_group_restore (int );
Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 1/5] Add support for subtest-specific documentation
Quoted 327 lines · Petri Latvala
The current documentation for tests is limited to a single string per test binary. This patch adds support for documenting individual subtests.
The syntax for subtest documentation is:
igt_document_subtest("Frob knobs to see if one of the "
"crossbeams will go out of skew on the " "treadle.\n");
igt_subtest("knob-frobbing-askew")
test_frob();or with a format string:
for_example_loop(e) { igt_document_subtest_f("Frob %s to see if one of the " "crossbeams will go out of skew on the " "treadle.\n", e->readable_name); igt_subtest_f("%s-frob-askew", e->name) test_frob(e); }The documentation cannot be extracted from just comments, because associating them with the correct subtest name will then require doing pattern matching in the documentation generator, for subtests where the name is generated at runtime using
igt_subtest_f.v2: Rebase, change function name in commit message to match code
v3: Fix current documentation string tracking, add missing
va_end(Vinay)v4: Fix brainfart in
__igt_run_subtestSigned-off-by Petri Latvala <[email protected]>Acked-by Leo Li <[email protected]>Acked-by Arkadiusz Hiler <[email protected]>--- lib/igt_aux.c | 8 ++-- lib/igt_core.c | 149 +++++++++++++++++++++++++++++++++++++++++++++------------ lib/igt_core.h | 6 ++- 3 files changed, 128 insertions(+), 35 deletions(-)lib/igt_aux.c +4
-4@@ -311,7 +311,7 @@ static void sig_handler(int i)*/ void igt_fork_signal_helper (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;/* We pick SIGCONT as it is a "safe" signal - if we send SIGCONT to @@ -344,7 +344,7 @@ void igt_fork_signal_helper(void)*/ void igt_stop_signal_helper (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;igt_stop_helper (&signal_helper);@@ -375,7 +375,7 @@ static void __attribute__((noreturn)) shrink_helper_process(int fd, pid_t pid)*/ void igt_fork_shrink_helper (int drm_fd) { -assert (!igt_only_list_subtests ()); +assert (!igt_only_collect_data ());igt_require (igt_drop_caches_has (drm_fd,DROP_SHRINK_ALL )); igt_fork_helper(&shrink_helper)shrink_helper_process (drm_fd,getppid ());@@ -473,7 +473,7 @@ void igt_stop_hang_detector(void)#else void igt_fork_hang_detector (int fd) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ; }lib/igt_core.c +109
-20@@ -99,7 +99,7 @@* * To allow this i-g-t provides #igt_fixture code blocks for setup code outside * of subtests and automatically skips the subtest code blocks themselves. For -* special cases igt_only_list_subtests() is also provided. For setup code only +* special cases igt_only_collect_data() is also provided. For setup code only * shared by a group of subtest encapsulate the #igt_fixture block and all the * subtestest in a #igt_subtest_group block. * @@ -253,9 +253,9 @@ static unsigned int exit_handler_count;const char *igt_interactive_debug;/* subtests helpers */ -static bool list_subtests = false; -static char *run_single_subtest =NULL ; -static bool run_single_subtest_found = false; +static char *single_subtest =NULL ; +static bool single_subtest_found = false; +static char *current_subtest_documentation =NULL ;static const char *in_subtest =NULL ;static struct timespec subtest_time;static clockid_t igt_clock = (clockid_t)-1 ;@@ -265,6 +265,13 @@ static bool in_atexit_handler = false;static enum {CONT =0 ,SKIP ,FAIL } skip_subtests_henceforth =CONT ; +static enum { +EXECUTE_ALL , +EXECUTE_SINGLE , +LIST_SUBTESTS , +DOCUMENT , +DOCUMENT_SINGLE +} runmode =EXECUTE_ALL ;bool __igt_plain_output = false;@@ -277,6 +284,8 @@ bool test_child;enum {OPT_LIST_SUBTESTS ,OPT_RUN_SUBTEST , +OPT_DOC_SUBTESTS , +OPT_DOC_SINGLE_SUBTEST ,OPT_DESCRIPTION ,OPT_DEBUG ,OPT_INTERACTIVE_DEBUG ,@@ -469,7 +478,7 @@ bool __igt_fixture(void) {assert (!in_fixture); -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return false;if (skip_subtests_henceforth)@@ -563,7 +572,7 @@ static void low_mem_killer_disable(bool disable)bool igt_exit_called;static void common_exit_handler (int sig) { -if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) {low_mem_killer_disable (false);kick_fbcon (true); }@@ -583,7 +592,7 @@ static void print_version(void) {struct utsname uts; -if (list_subtests) +if (igt_only_collect_data ())return ;uname (&uts);@@ -599,6 +608,8 @@ static void print_usage(const char *help_str, bool output_on_stderr)fprintf (f,"Usage: %s [OPTIONS]\n" , command_str);fprintf (f," --list-subtests\n" +" --document-all-subtests\n" +" --document-subtest <pattern>\n" " --run-subtest <pattern>\n" " --debug[=log-domain]\n" " --interactive-debug[=domain]\n"@@ -710,6 +721,8 @@ static int common_init(int *argc, char **argv,static struct option long_options[] = { {"list-subtests" ,0 ,0 ,OPT_LIST_SUBTESTS }, {"run-subtest" ,1 ,0 ,OPT_RUN_SUBTEST }, + {"document-all-subtests" ,0 ,0 ,OPT_DOC_SUBTESTS }, + {"document-subtest" ,1 ,0 ,OPT_DOC_SINGLE_SUBTEST }, {"help-description" ,0 ,0 ,OPT_DESCRIPTION }, {"debug" , optional_argument,0 ,OPT_DEBUG }, {"interactive-debug" , optional_argument,0 ,OPT_INTERACTIVE_DEBUG },@@ -800,12 +813,24 @@ static int common_init(int *argc, char **argv, igt_log_domain_filter =strdup (optarg);break ;case OPT_LIST_SUBTESTS : -if (!run_single_subtest) - list_subtests = true; +if (runmode ==EXECUTE_ALL ) + runmode =LIST_SUBTESTS ;break ;case OPT_RUN_SUBTEST : -if (!list_subtests) - run_single_subtest =strdup (optarg); +if (runmode ==EXECUTE_ALL ) { + runmode =EXECUTE_SINGLE ; + single_subtest =strdup (optarg); + } +break ; +case OPT_DOC_SUBTESTS : +if (runmode ==EXECUTE_ALL ) + runmode =DOCUMENT ; +break ; +case OPT_DOC_SINGLE_SUBTEST : +if (runmode ==EXECUTE_ALL ) { + runmode =DOCUMENT_SINGLE ; + single_subtest =strdup (optarg); + }break ;case OPT_DESCRIPTION :print_test_description ();@@ -837,11 +862,11 @@ out:/* exit immediately if this test has no subtests and a subtest or the * list of subtests has been requested */ if (!test_with_subtests) { -if (run_single_subtest) { -igt_warn ("Unknown subtest: %s\n" , run_single_subtest); +if (runmode ==EXECUTE_SINGLE || runmode ==DOCUMENT_SINGLE ) { +igt_warn ("Unknown subtest: %s\n" , single_subtest);exit (IGT_EXIT_INVALID ); } -if (list_subtests) +if (runmode ==LIST_SUBTESTS || runmode ==DOCUMENT )exit (IGT_EXIT_INVALID ); }@@ -849,7 +874,7 @@ out:/* exit with no error for -h/--help */ exit (ret ==-1 ?0 :IGT_EXIT_INVALID ); -if (!list_subtests) { +if (!igt_only_collect_data ()) {kick_fbcon (false);kmsg (KERN_INFO "[IGT] %s: executing\n" , command_str);print_version ();@@ -957,16 +982,38 @@ bool __igt_run_subtest(const char *subtest_name)igt_exit (); } -if (list_subtests) { +if (runmode ==LIST_SUBTESTS ) {printf ("%s\n" , subtest_name);return false; } -if (run_single_subtest) { -if (uwildmat (subtest_name, run_single_subtest) ==0 ) +if (runmode ==DOCUMENT ) { +if (current_subtest_documentation) { +printf ("%s:\n\n" , subtest_name); +printf ("%s" , current_subtest_documentation); +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + } +return false; + } + +if (runmode ==EXECUTE_SINGLE || runmode ==DOCUMENT_SINGLE ) { +bool stop = runmode ==DOCUMENT_SINGLE ; + +if (uwildmat (subtest_name, single_subtest)) { + single_subtest_found = true; + +if (runmode ==DOCUMENT_SINGLE && current_subtest_documentation) +printf ("%s" , current_subtest_documentation); + }else { + stop = true; + } + +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + +if (stop)return false; -else - run_single_subtest_found = true; }if (skip_subtests_henceforth) {@@ -983,10 +1030,52 @@ bool __igt_run_subtest(const char *subtest_name)_igt_log_buffer_reset ();gettime (&subtest_time); +return (in_subtest = subtest_name); }/** +* igt_document_subtest: +* @documentation: documentation for the next subtest +* +* This function sets the documentation string for the next occurring subtest. +*/ +void igt_document_subtest (const char *documentation) +{ +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); + current_subtest_documentation =strdup (documentation); + } +} + +/** +* igt_document_subtest_f: +* @documentation: Documentation for the next subtest +* @...: format string and optional arguments +* +* This function sets the documentation string for the next occurring subtest. +* +* Like igt_document_subtest(), but also accepts a printf format +* string instead of a static string. +*/ +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...) +{ +int err; +va_list args; + +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); +va_start (args, documentation); + err =vasprintf (¤t_subtest_documentation, documentation, args); +va_end (args); +if (err <0 ) + current_subtest_documentation =NULL ; + } +} + + +/** * igt_subtest_name: * * Returns: The name of the currently executed subtest or NULL if called from
lib/igt_core.c const char *igt_subtest_name(void) · line 1087
Quoted 1 line
lib/igt_core.c +0
-0@@ -998,14 +1087,14 @@ const char *igt_subtest_name(void) }
Document subtest function works fine now, tried it with the latest patches. Also,
Quoted 68 lines
lib/igt_core.c +10
-10/** -* igt_only_list_subtests: +* igt_only_collect_data: * -* Returns: Returns true if only subtest should be listed and any setup code +* Returns: Returns true if the running mode is only collecting data and any setup code * must be skipped, false otherwise. */ -bool igt_only_list_subtests (void ) +bool igt_only_collect_data (void ) { -return list_subtests; +return runmode !=EXECUTE_ALL && runmode !=EXECUTE_SINGLE ; }void __igt_subtest_group_save (int *save)@@ -1059,7 +1148,7 @@ void igt_skip(const char *f, ...)assert (!test_child); -if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) {va_start (args, f);vprintf (f, args);va_end (args);@@ -1443,12 +1532,12 @@ void igt_exit(void)g_key_file_free (igt_key_file);#endif -if (run_single_subtest && !run_single_subtest_found) { -igt_warn ("Unknown subtest: %s\n" , run_single_subtest); +if (single_subtest && !single_subtest_found) { +igt_warn ("Unknown subtest: %s\n" , single_subtest);exit (IGT_EXIT_INVALID ); } -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())exit (IGT_EXIT_SUCCESS );/* Calling this without calling one of the above is a failure */ @@ -2012,7 +2101,7 @@ bool igt_run_in_simulation(void)*/ void igt_skip_on_simulation (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;if (!in_fixture && !in_subtest) {@@ -2087,7 +2176,7 @@ void igt_vlog(const char *domain, enum igt_log_level level, const char *format, program_name = command_str;#endif -if (list_subtests && level <=IGT_LOG_WARN ) +if (igt_only_collect_data () && level <=IGT_LOG_WARN )return ;if (vasprintf (&line, format, args) ==-1 )lib/igt_core.h +0
-0@@ -197,8 +197,12 @@ bool __igt_run_subtest(const char *subtest_name); #define igt_subtest_f(f...) \ __igt_subtest_f(igt_tokencat(__tmpchar, __LINE__), f)
lib/igt_core.h bool __igt_run_subtest(const char *subtest_name); · line 208
Quoted 10 lines
lib/igt_core.h +5
-1+void igt_document_subtest (const char *documentation); +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...); +const char *igt_subtest_name (void ); -bool igt_only_list_subtests (void ); +bool igt_only_collect_data (void );void __igt_subtest_group_save (int *);void __igt_subtest_group_restore (int );
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 1/5] Add support for subtest-specific documentation
In reply to Petri LatvalaQuoted 14 lines · Petri Latvala
The current documentation for tests is limited to a single string per test binary. This patch adds support for documenting individual subtests.
The syntax for subtest documentation is:
igt_document_subtest("Frob knobs to see if one of the "
"crossbeams will go out of skew on the " "treadle.\n");
igt_subtest("knob-frobbing-askew")test_frob();or with a format string:
Quoted 7 lines
for_example_loop(e) {
igt_document_subtest_f("Frob %s to see if one of the "
"crossbeams will go out of skew on the "
"treadle.\n", e->readable_name);
igt_subtest_f("%s-frob-askew", e->name)
test_frob(e);
}I'm not sold on this layout at all. Everywhere else where we do in-line code documentation it is through specially formatted comments. That gives you a lot of freedom for plain-text layout, in combination with some mild markup (gtk-doc for igt and rst for kernel) that result in docs which both look good in the code and look good rendered.
This here essentially restricts you to one-liners, and a one-liner can't really explain what a more complext test does.
If we imagine what e.g. Paulo's test documentation in kms_frontbuffer_tracking.c looks like, it'll be bad.
I thought the test documentation that Thomas Wood worked on (no idea about status) would give us the full power and expressiveness of gtkdoc, but for binaries. I think that's what we want.
Then for testcases I think we again want to follow the inline documentation style, perhaps with something like the below:
/**
* IGT-Subtest: tests some stuff
*
* Longer explanation of test approach and result evalution.
*
* Maybe over multiple paragraphs with headlines like CAVEATS, or
* explaining hw bugs and stuff
*/
igt_subtest("bla-bla-subtest")There's also the question of how to associate a given doc entry with more the multiple subtest names that igt_subtest_f can generate, but I guess that should be solveable.
Any, in my opinion documentation has to look pleasing, both in code and rendered, otherwise people will not look at it, not write it and not update it. Or worse, they stick to writing full comments, because that's the only thing that allows them to express what they want to document.
We need something much better imo than this patch series from that pov.
Thanks, Daniel
Quoted 391 lines
The documentation cannot be extracted from just comments, because associating them with the correct subtest name will then require doing pattern matching in the documentation generator, for subtests where the name is generated at runtime using
igt_subtest_f.v2: Rebase, change function name in commit message to match code
v3: Fix current documentation string tracking, add missing
va_end(Vinay)v4: Fix brainfart in
__igt_run_subtestSigned-off-by Petri Latvala <[email protected]>Acked-by Leo Li <[email protected]>Acked-by Arkadiusz Hiler <[email protected]>--- lib/igt_aux.c | 8 ++-- lib/igt_core.c | 149 +++++++++++++++++++++++++++++++++++++++++++++------------ lib/igt_core.h | 6 ++- 3 files changed, 128 insertions(+), 35 deletions(-)lib/igt_aux.c +4
-4@@ -311,7 +311,7 @@ static void sig_handler(int i)*/ void igt_fork_signal_helper (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;/* We pick SIGCONT as it is a "safe" signal - if we send SIGCONT to @@ -344,7 +344,7 @@ void igt_fork_signal_helper(void)*/ void igt_stop_signal_helper (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;igt_stop_helper (&signal_helper);@@ -375,7 +375,7 @@ static void __attribute__((noreturn)) shrink_helper_process(int fd, pid_t pid)*/ void igt_fork_shrink_helper (int drm_fd) { -assert (!igt_only_list_subtests ()); +assert (!igt_only_collect_data ());igt_require (igt_drop_caches_has (drm_fd,DROP_SHRINK_ALL )); igt_fork_helper(&shrink_helper)shrink_helper_process (drm_fd,getppid ());@@ -473,7 +473,7 @@ void igt_stop_hang_detector(void)#else void igt_fork_hang_detector (int fd) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ; }lib/igt_core.c +119
-30@@ -99,7 +99,7 @@* * To allow this i-g-t provides #igt_fixture code blocks for setup code outside * of subtests and automatically skips the subtest code blocks themselves. For -* special cases igt_only_list_subtests() is also provided. For setup code only +* special cases igt_only_collect_data() is also provided. For setup code only * shared by a group of subtest encapsulate the #igt_fixture block and all the * subtestest in a #igt_subtest_group block. * @@ -253,9 +253,9 @@ static unsigned int exit_handler_count;const char *igt_interactive_debug;/* subtests helpers */ -static bool list_subtests = false; -static char *run_single_subtest =NULL ; -static bool run_single_subtest_found = false; +static char *single_subtest =NULL ; +static bool single_subtest_found = false; +static char *current_subtest_documentation =NULL ;static const char *in_subtest =NULL ;static struct timespec subtest_time;static clockid_t igt_clock = (clockid_t)-1 ;@@ -265,6 +265,13 @@ static bool in_atexit_handler = false;static enum {CONT =0 ,SKIP ,FAIL } skip_subtests_henceforth =CONT ; +static enum { +EXECUTE_ALL , +EXECUTE_SINGLE , +LIST_SUBTESTS , +DOCUMENT , +DOCUMENT_SINGLE +} runmode =EXECUTE_ALL ;bool __igt_plain_output = false;@@ -277,6 +284,8 @@ bool test_child;enum {OPT_LIST_SUBTESTS ,OPT_RUN_SUBTEST , +OPT_DOC_SUBTESTS , +OPT_DOC_SINGLE_SUBTEST ,OPT_DESCRIPTION ,OPT_DEBUG ,OPT_INTERACTIVE_DEBUG ,@@ -469,7 +478,7 @@ bool __igt_fixture(void) {assert (!in_fixture); -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return false;if (skip_subtests_henceforth)@@ -563,7 +572,7 @@ static void low_mem_killer_disable(bool disable)bool igt_exit_called;static void common_exit_handler (int sig) { -if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) {low_mem_killer_disable (false);kick_fbcon (true); }@@ -583,7 +592,7 @@ static void print_version(void) {struct utsname uts; -if (list_subtests) +if (igt_only_collect_data ())return ;uname (&uts);@@ -599,6 +608,8 @@ static void print_usage(const char *help_str, bool output_on_stderr)fprintf (f,"Usage: %s [OPTIONS]\n" , command_str);fprintf (f," --list-subtests\n" +" --document-all-subtests\n" +" --document-subtest <pattern>\n" " --run-subtest <pattern>\n" " --debug[=log-domain]\n" " --interactive-debug[=domain]\n"@@ -710,6 +721,8 @@ static int common_init(int *argc, char **argv,static struct option long_options[] = { {"list-subtests" ,0 ,0 ,OPT_LIST_SUBTESTS }, {"run-subtest" ,1 ,0 ,OPT_RUN_SUBTEST }, + {"document-all-subtests" ,0 ,0 ,OPT_DOC_SUBTESTS }, + {"document-subtest" ,1 ,0 ,OPT_DOC_SINGLE_SUBTEST }, {"help-description" ,0 ,0 ,OPT_DESCRIPTION }, {"debug" , optional_argument,0 ,OPT_DEBUG }, {"interactive-debug" , optional_argument,0 ,OPT_INTERACTIVE_DEBUG },@@ -800,12 +813,24 @@ static int common_init(int *argc, char **argv, igt_log_domain_filter =strdup (optarg);break ;case OPT_LIST_SUBTESTS : -if (!run_single_subtest) - list_subtests = true; +if (runmode ==EXECUTE_ALL ) + runmode =LIST_SUBTESTS ;break ;case OPT_RUN_SUBTEST : -if (!list_subtests) - run_single_subtest =strdup (optarg); +if (runmode ==EXECUTE_ALL ) { + runmode =EXECUTE_SINGLE ; + single_subtest =strdup (optarg); + } +break ; +case OPT_DOC_SUBTESTS : +if (runmode ==EXECUTE_ALL ) + runmode =DOCUMENT ; +break ; +case OPT_DOC_SINGLE_SUBTEST : +if (runmode ==EXECUTE_ALL ) { + runmode =DOCUMENT_SINGLE ; + single_subtest =strdup (optarg); + }break ;case OPT_DESCRIPTION :print_test_description ();@@ -837,11 +862,11 @@ out:/* exit immediately if this test has no subtests and a subtest or the * list of subtests has been requested */ if (!test_with_subtests) { -if (run_single_subtest) { -igt_warn ("Unknown subtest: %s\n" , run_single_subtest); +if (runmode ==EXECUTE_SINGLE || runmode ==DOCUMENT_SINGLE ) { +igt_warn ("Unknown subtest: %s\n" , single_subtest);exit (IGT_EXIT_INVALID ); } -if (list_subtests) +if (runmode ==LIST_SUBTESTS || runmode ==DOCUMENT )exit (IGT_EXIT_INVALID ); }@@ -849,7 +874,7 @@ out:/* exit with no error for -h/--help */ exit (ret ==-1 ?0 :IGT_EXIT_INVALID ); -if (!list_subtests) { +if (!igt_only_collect_data ()) {kick_fbcon (false);kmsg (KERN_INFO "[IGT] %s: executing\n" , command_str);print_version ();@@ -957,16 +982,38 @@ bool __igt_run_subtest(const char *subtest_name)igt_exit (); } -if (list_subtests) { +if (runmode ==LIST_SUBTESTS ) {printf ("%s\n" , subtest_name);return false; } -if (run_single_subtest) { -if (uwildmat (subtest_name, run_single_subtest) ==0 ) +if (runmode ==DOCUMENT ) { +if (current_subtest_documentation) { +printf ("%s:\n\n" , subtest_name); +printf ("%s" , current_subtest_documentation); +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + } +return false; + } + +if (runmode ==EXECUTE_SINGLE || runmode ==DOCUMENT_SINGLE ) { +bool stop = runmode ==DOCUMENT_SINGLE ; + +if (uwildmat (subtest_name, single_subtest)) { + single_subtest_found = true; + +if (runmode ==DOCUMENT_SINGLE && current_subtest_documentation) +printf ("%s" , current_subtest_documentation); + }else { + stop = true; + } + +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + +if (stop)return false; -else - run_single_subtest_found = true; }if (skip_subtests_henceforth) {@@ -983,10 +1030,52 @@ bool __igt_run_subtest(const char *subtest_name)_igt_log_buffer_reset ();gettime (&subtest_time); +return (in_subtest = subtest_name); }/** +* igt_document_subtest: +* @documentation: documentation for the next subtest +* +* This function sets the documentation string for the next occurring subtest. +*/ +void igt_document_subtest (const char *documentation) +{ +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); + current_subtest_documentation =strdup (documentation); + } +} + +/** +* igt_document_subtest_f: +* @documentation: Documentation for the next subtest +* @...: format string and optional arguments +* +* This function sets the documentation string for the next occurring subtest. +* +* Like igt_document_subtest(), but also accepts a printf format +* string instead of a static string. +*/ +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...) +{ +int err; +va_list args; + +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); +va_start (args, documentation); + err =vasprintf (¤t_subtest_documentation, documentation, args); +va_end (args); +if (err <0 ) + current_subtest_documentation =NULL ; + } +} + + +/** * igt_subtest_name: * * Returns: The name of the currently executed subtest or NULL if called from @@ -998,14 +1087,14 @@ const char *igt_subtest_name(void) }/** -* igt_only_list_subtests: +* igt_only_collect_data: * -* Returns: Returns true if only subtest should be listed and any setup code +* Returns: Returns true if the running mode is only collecting data and any setup code * must be skipped, false otherwise. */ -bool igt_only_list_subtests (void ) +bool igt_only_collect_data (void ) { -return list_subtests; +return runmode !=EXECUTE_ALL && runmode !=EXECUTE_SINGLE ; }void __igt_subtest_group_save (int *save)@@ -1059,7 +1148,7 @@ void igt_skip(const char *f, ...)assert (!test_child); -if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) {va_start (args, f);vprintf (f, args);va_end (args);@@ -1443,12 +1532,12 @@ void igt_exit(void)g_key_file_free (igt_key_file);#endif -if (run_single_subtest && !run_single_subtest_found) { -igt_warn ("Unknown subtest: %s\n" , run_single_subtest); +if (single_subtest && !single_subtest_found) { +igt_warn ("Unknown subtest: %s\n" , single_subtest);exit (IGT_EXIT_INVALID ); } -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())exit (IGT_EXIT_SUCCESS );/* Calling this without calling one of the above is a failure */ @@ -2012,7 +2101,7 @@ bool igt_run_in_simulation(void)*/ void igt_skip_on_simulation (void ) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return ;if (!in_fixture && !in_subtest) {@@ -2087,7 +2176,7 @@ void igt_vlog(const char *domain, enum igt_log_level level, const char *format, program_name = command_str;#endif -if (list_subtests && level <=IGT_LOG_WARN ) +if (igt_only_collect_data () && level <=IGT_LOG_WARN )return ;if (vasprintf (&line, format, args) ==-1 )lib/igt_core.h +5
-1@@ -197,8 +197,12 @@ bool __igt_run_subtest(const char *subtest_name); #define igt_subtest_f(f...) \ __igt_subtest_f(igt_tokencat(__tmpchar, __LINE__), f) +void igt_document_subtest (const char *documentation); +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...); +const char *igt_subtest_name (void ); -bool igt_only_list_subtests (void ); +bool igt_only_collect_data (void );void __igt_subtest_group_save (int *);void __igt_subtest_group_restore (int );Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Signature · 7 lines
Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 1/5] Add support for subtest-specific documentation
Quoted 23 lines · Daniel Vetter
Quoted 14 lines · Petri Latvala
The current documentation for tests is limited to a single string per test binary. This patch adds support for documenting individual subtests.
The syntax for subtest documentation is:
igt_document_subtest("Frob knobs to see if one of the " "crossbeams will go out of skew on the " "treadle.\n");
igt_subtest("knob-frobbing-askew")
test_frob();or with a format string:
Quoted 7 lines
for_example_loop(e){
igt_document_subtest_f("Frob %s to see if one of the " "crossbeams will go out of skew on the " "treadle.\n",e->readable_name);igt_subtest_f("%s-frob-askew", e->name)test_frob(e);
}
Quoted 8 lines
I'm not sold on this layout at all. Everywhere else where we do in-line code documentation it is through specially formatted comments. That gives you a lot of freedom for plain-text layout, in combination with some mild markup (gtk-doc for igt and rst for kernel) that result in docs which both look good in the code and look good rendered.
This here essentially restricts you to one-liners, and a one-liner can't really explain what a more complext test does.
I second that. For many cases one-liner will do - but these more complicated cases are really worth the effort when documenting.
Quoted 23 lines
If we imagine what e.g. Paulo's test documentation in
kms_frontbuffer_tracking.clooks like, it'll be bad.I thought the test documentation that Thomas Wood worked on (no idea about status) would give us the full power and expressiveness of gtkdoc, but for binaries. I think that's what we want.
Then for testcases I think we again want to follow the inline documentation style, perhaps with something like the below:
/** * IGT-Subtest: tests some stuff * * Longer explanation of test approach and result evalution. * * Maybe over multiple paragraphs with headlines like CAVEATS, or * explaining hw bugs and stuff */ igt_subtest("bla-bla-subtest")
Quoted 3 lines
There's also the question of how to associate a given doc entry with more the multiple subtest names that
igt_subtest_fcan generate, but I guess that should be solveable.
I don't think its even worth having same text with just single words changed generated for every subtest if test name describes the difference (and I guess in many cases that is what we have now). It would be good to document such tests in groups.
Thanks,
Radek
Quoted 418 lines
Any, in my opinion documentation has to look pleasing, both in code and rendered, otherwise people will not look at it, not write it and not update it. Or worse, they stick to writing full comments, because that's the only thing that allows them to express what they want to document.
We need something much better imo than this patch series from that pov.
Thanks, Daniel
Quoted 408 lines
The documentation cannot be extracted from just comments, because associating them with the correct subtest name will then require doing pattern matching in the documentation generator, for subtests where the name is generated at runtime using
igt_subtest_f.v2: Rebase, change function name in commit message to match code
v3: Fix current documentation string tracking, add missing
va_end(Vinay)v4: Fix brainfart in
__igt_run_subtestSigned-off-by Petri Latvala <[email protected]>Acked-by Leo Li <[email protected]>Acked-by Arkadiusz Hiler <[email protected]>---
lib/igt_aux.c | 8 ++--
lib/igt_core.c | 149 +++++++++++++++++++++++++++++++++++++++++++++---------
---
lib/igt_core.h | 6 ++-3 files changed, 128 insertions(+), 35 deletions(-)lib/igt_aux.c +1
-1@@ -311,7 +311,7 @@ static void sig_handler(int i)*/ void igt_fork_signal_helper(void) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return;
/* We pick SIGCONT as it is a "safe" signal - if we send SIGCONT tolib/igt_aux.c +1
-1@@ -344,7 +344,7 @@ void igt_fork_signal_helper(void)*/ void igt_stop_signal_helper(void) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return;
igt_stop_helper(&signal_helper);lib/igt_aux.c +1
-1@@ -375,7 +375,7 @@ static void __attribute__((noreturn))shrink_helper_process(int fd, pid_t pid) */ void igt_fork_shrink_helper(int drm_fd) { -assert (!igt_only_list_subtests ()); +assert (!igt_only_collect_data ()); igt_require(igt_drop_caches_has(drm_fd, DROP_SHRINK_ALL)); igt_fork_helper(&shrink_helper)
shrink_helper_process(drm_fd, getppid());lib/igt_aux.c +1
-1@@ -473,7 +473,7 @@ void igt_stop_hang_detector(void) #else void igt_fork_hang_detector(int fd) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return; }lib/igt_core.c +0
-0@@ -99,7 +99,7 @@ * * To allow this i-g-t provides #igt_fixture code blocks for setup codeoutside
* of subtests and automatically skips the subtest code blocks themselves. For
- * special casesigt_only_list_subtests()is also provided. For setup code only
+ * special casesigt_only_collect_data()is also provided. For setup code only
* shared by a group of subtest encapsulate the #igt_fixture block and all the
* subtestest in a #igt_subtest_group block.
*lib/igt_core.c +0
-0@@ -253,9 +253,9 @@ static unsigned int exit_handler_count; const char *igt_interactive_debug;
/* subtests helpers */lib/igt_core.c +3
-3-static bool list_subtests = false; -static char *run_single_subtest =NULL ; -static bool run_single_subtest_found = false; +static char *single_subtest =NULL ; +static bool single_subtest_found = false; +static char *current_subtest_documentation =NULL ;static const char
*in_subtest= NULL;
static struct timespecsubtest_time;
staticclockid_tigt_clock= (clockid_t)-1;lib/igt_core.c +0
-0@@ -265,6 +265,13 @@ static bool in_atexit_handler = false; static enum {CONT = 0, SKIP, FAIL
}skip_subtests_henceforth= CONT;lib/igt_core.c +7
-0+static enum { +EXECUTE_ALL , +EXECUTE_SINGLE , +LIST_SUBTESTS , +DOCUMENT , +DOCUMENT_SINGLE +} runmode =EXECUTE_ALL ;
bool__igt_plain_output= false;lib/igt_core.c +2
-0@@ -277,6 +284,8 @@ bool test_child; enum { OPT_LIST_SUBTESTS, OPT_RUN_SUBTEST, +OPT_DOC_SUBTESTS , +OPT_DOC_SINGLE_SUBTEST , OPT_DESCRIPTION, OPT_DEBUG, OPT_INTERACTIVE_DEBUG,@@ -469,7 +478,7 @@ bool __igt_fixture(void) { assert(!in_fixture);lib/igt_core.c +1
-1-if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return false;
if (skip_subtests_henceforth)lib/igt_core.c +1
-1@@ -563,7 +572,7 @@ static void low_mem_killer_disable(bool disable) bool igt_exit_called; static void common_exit_handler(int sig) { -if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) { low_mem_killer_disable(false); kick_fbcon(true); }@@ -583,7 +592,7 @@ static void print_version(void) { struct utsname uts;lib/igt_core.c +1
-1-if (list_subtests) +if (igt_only_collect_data ())return;
uname(&uts);lib/igt_core.c +0
-0@@ -599,6 +608,8 @@ static void print_usage(const char *help_str, bool output_on_stderr)
fprintf(f, "Usage: %s [OPTIONS]\n", command_str); fprintf(f, " --list-subtests\n"lib/igt_core.c +2
-0+ " --document-all-subtests\n" + " --document-subtest <pattern>\n"" --run-subtest <pattern>\n" " --debug[=log-domain]\n" " --interactive-debug[=domain]\n"
lib/igt_core.c +2
-0@@ -710,6 +721,8 @@ static int common_init(int *argc, char **argv, static struct option long_options[] = { {"list-subtests", 0, 0, OPT_LIST_SUBTESTS}, {"run-subtest", 1, 0, OPT_RUN_SUBTEST}, + {"document-all-subtests" ,0 ,0 ,OPT_DOC_SUBTESTS }, + {"document-subtest" ,1 ,0 ,OPT_DOC_SINGLE_SUBTEST }, {"help-description", 0, 0, OPT_DESCRIPTION}, {"debug", optional_argument, 0, OPT_DEBUG}, {"interactive-debug", optional_argument, 0,
OPT_INTERACTIVE_DEBUG},lib/igt_core.c +0
-0@@ -800,12 +813,24 @@ static int common_init(int *argc, char **argv, igt_log_domain_filter = strdup(optarg); break;case
OPT_LIST_SUBTESTS:lib/igt_core.c +2
-2-if (!run_single_subtest) - list_subtests = true; +if (runmode ==EXECUTE_ALL ) + runmode =LIST_SUBTESTS ;break;
caseOPT_RUN_SUBTEST:lib/igt_core.c +14
-2-if (!list_subtests) - run_single_subtest =strdup (optarg); +if (runmode ==EXECUTE_ALL ) { + runmode =EXECUTE_SINGLE ; + single_subtest =strdup (optarg); + } +break ; +case OPT_DOC_SUBTESTS : +if (runmode ==EXECUTE_ALL ) + runmode =DOCUMENT ; +break ; +case OPT_DOC_SINGLE_SUBTEST : +if (runmode ==EXECUTE_ALL ) { + runmode =DOCUMENT_SINGLE ; + single_subtest =strdup (optarg); + }break;
caseOPT_DESCRIPTION:
print_test_description();lib/igt_core.c +0
-0@@ -837,11 +862,11 @@ out: /* exit immediately if this test has no subtests and a subtest orthe
* list of subtests has been requested */
if (!test_with_subtests) {lib/igt_core.c +0
-2-if (run_single_subtest) { - igt_warn("Unknown subtest: %s\n",
run_single_subtest);lib/igt_core.c +1
-0+ if (runmode == EXECUTE_SINGLE || runmode ==
DOCUMENT_SINGLE) {lib/igt_core.c +1
-0+igt_warn ("Unknown subtest: %s\n" , single_subtest);
exit(IGT_EXIT_INVALID);
}lib/igt_core.c +1
-1-if (list_subtests) +if (runmode ==LIST_SUBTESTS || runmode ==DOCUMENT )
exit(IGT_EXIT_INVALID);
}lib/igt_core.c +0
-0@@ -849,7 +874,7 @@ out: /* exit with no error for -h/--help */ exit(ret == -1 ? 0 : IGT_EXIT_INVALID);lib/igt_core.c +1
-1-if (!list_subtests) { +if (!igt_only_collect_data ()) {
kick_fbcon(false);
kmsg(KERN_INFO "[IGT] %s: executing\n", command_str);print_version();lib/igt_core.c +0
-0@@ -957,16 +982,38 @@ bool __igt_run_subtest(const char *subtest_name) igt_exit(); }lib/igt_core.c +1
-1-if (list_subtests) { +if (runmode ==LIST_SUBTESTS ) {
printf("%s\n", subtest_name);
return false;
}lib/igt_core.c +17
-2-if (run_single_subtest) { -if (uwildmat (subtest_name, run_single_subtest) ==0 ) +if (runmode ==DOCUMENT ) { +if (current_subtest_documentation) { +printf ("%s:\n\n" , subtest_name); +printf ("%s" , current_subtest_documentation); +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + } +return false; + } + +if (runmode ==EXECUTE_SINGLE || runmode ==DOCUMENT_SINGLE ) { +bool stop = runmode ==DOCUMENT_SINGLE ; + +if (uwildmat (subtest_name, single_subtest)) { + single_subtest_found = true; + + if (runmode == DOCUMENT_SINGLE &&
current_subtest_documentation)lib/igt_core.c +1
-0+ printf("%s",
current_subtest_documentation);lib/igt_core.c +8
-0+ }else { + stop = true; + } + +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + +if (stop)return false;
lib/igt_core.c +0
-2-else - run_single_subtest_found = true;}
if (skip_subtests_henceforth) {lib/igt_core.c +0
-0@@ -983,10 +1030,52 @@ bool __igt_run_subtest(const char *subtest_name) _igt_log_buffer_reset();
gettime(&subtest_time);
+
return (in_subtest=subtest_name);
}
/**
+ *igt_document_subtest:
+ * @documentation: documentation for the next subtest
+ *
+ * This function sets the documentation string for the next occurring subtest.
+ */lib/igt_core.c +14
-0+void igt_document_subtest (const char *documentation) +{ +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); + current_subtest_documentation =strdup (documentation); + } +} + +/** +* igt_document_subtest_f: +* @documentation: Documentation for the next subtest +* @...: format string and optional arguments +* +* This function sets the documentation string for the next occurring subtest.
+ *
+ * Likeigt_document_subtest(), but also accepts a printf format
+ * string instead of a static string.
+ */lib/igt_core.c +10
-0+__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...) +{ +int err; +va_list args; + +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); +va_start (args, documentation); + err = vasprintf(¤t_subtest_documentation,documentation, args);
lib/igt_core.c +8
-0+va_end (args); +if (err <0 ) + current_subtest_documentation =NULL ; + } +} + + +/** *
igt_subtest_name:
*
* Returns: The name of the currently executed subtest or NULL if called fromlib/igt_core.c +0
-0@@ -998,14 +1087,14 @@ const char *igt_subtest_name(void) }
/**
- *igt_only_list_subtests:
+ *igt_only_collect_data:
*
- * Returns: Returns true if only subtest should be listed and any setup code
+ * Returns: Returns true if the running mode is only collecting data and any setup code
* must be skipped, false otherwise.
*/lib/igt_core.c +1
-1-bool igt_only_list_subtests (void ) +bool igt_only_collect_data (void ){
lib/igt_core.c +1
-1-return list_subtests; +return runmode !=EXECUTE_ALL && runmode !=EXECUTE_SINGLE ;}
void__igt_subtest_group_save(int *save)lib/igt_core.c +0
-0@@ -1059,7 +1148,7 @@ void igt_skip(const char *f, ...)
assert(!test_child);lib/igt_core.c +1
-1-if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) {
va_start(args, f);
vprintf(f, args);
va_end(args);lib/igt_core.c +0
-0@@ -1443,12 +1532,12 @@ void igt_exit(void) g_key_file_free(igt_key_file); #endiflib/igt_core.c +2
-2-if (run_single_subtest && !run_single_subtest_found) { -igt_warn ("Unknown subtest: %s\n" , run_single_subtest); +if (single_subtest && !single_subtest_found) { +igt_warn ("Unknown subtest: %s\n" , single_subtest);
exit(IGT_EXIT_INVALID);
}lib/igt_core.c +1
-1-if (igt_only_list_subtests ()) +if (igt_only_collect_data ())
exit(IGT_EXIT_SUCCESS);
/* Calling this without calling one of the above is a failure */lib/igt_core.c +1
-1@@ -2012,7 +2101,7 @@ bool igt_run_in_simulation(void)*/ void igt_skip_on_simulation(void) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return;
if (!in_fixture && !in_subtest) {lib/igt_core.c +0
-0@@ -2087,7 +2176,7 @@ void igt_vlog(const char *domain, enum igt_log_level level, const char *format, program_name = command_str; #endiflib/igt_core.c +1
-1-if (list_subtests && level <=IGT_LOG_WARN ) +if (igt_only_collect_data () && level <=IGT_LOG_WARN )return;
if (vasprintf(&line, format, args)== -1)lib/igt_core.h +0
-0@@ -197,8 +197,12 @@ bool __igt_run_subtest(const char *subtest_name); #define igt_subtest_f(f...) \ __igt_subtest_f(igt_tokencat(__tmpchar, __LINE__), f)lib/igt_core.h +4
-0+void igt_document_subtest (const char *documentation); +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...); +const char
*igt_subtest_name(void);lib/igt_core.h +1
-1-bool igt_only_list_subtests (void ); +bool igt_only_collect_data (void );
void__igt_subtest_group_save(int *);
void__igt_subtest_group_restore(int);
--
2.9.3
Quoted 6 lines
Quoted 4 lines
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 1/5] Add support for subtest-specific documentation
Quoted 30 lines · Radoslaw
Quoted 29 lines · Daniel Vetter
Quoted 14 lines · Petri Latvala
The current documentation for tests is limited to a single string per test binary. This patch adds support for documenting individual subtests.
The syntax for subtest documentation is:
igt_document_subtest("Frob knobs to see if one of the " "crossbeams will go out of skew on the " "treadle.\n");
igt_subtest("knob-frobbing-askew")
test_frob();or with a format string:
Quoted 7 lines
for_example_loop(e){
igt_document_subtest_f("Frob %s to see if one of the " "crossbeams will go out of skew on the " "treadle.\n",e->readable_name);igt_subtest_f("%s-frob-askew", e->name)test_frob(e);
}I'm not sold on this layout at all. Everywhere else where we do in-line code documentation it is through specially formatted comments. That gives you a lot of freedom for plain-text layout, in combination with some mild markup (gtk-doc for igt and rst for kernel) that result in docs which both look good in the code and look good rendered.
Quoted 4 lines
Quoted 2 lines
This here essentially restricts you to one-liners, and a one-liner can't really explain what a more complext test does.
I second that. For many cases one-liner will do - but these more complicated cases are really worth the effort when documenting.
I'm definitely not against documenting more involved testcases, e.g. kms_frontbuffer_tracking. But this RFC here very much suggests a lot more beaurocracy documenting everything, and not really some in-depth comments where needed.
Quoted 22 lines
Quoted 22 lines
If we imagine what e.g. Paulo's test documentation in
kms_frontbuffer_tracking.clooks like, it'll be bad.I thought the test documentation that Thomas Wood worked on (no idea about status) would give us the full power and expressiveness of gtkdoc, but for binaries. I think that's what we want.
Then for testcases I think we again want to follow the inline documentation style, perhaps with something like the below:
/** * IGT-Subtest: tests some stuff * * Longer explanation of test approach and result evalution. * * Maybe over multiple paragraphs with headlines like CAVEATS, or * explaining hw bugs and stuff */ igt_subtest("bla-bla-subtest")
Quoted 7 lines
Quoted 3 lines
There's also the question of how to associate a given doc entry with more the multiple subtest names that
igt_subtest_fcan generate, but I guess that should be solveable.I don't think its even worth having same text with just single words changed generated for every subtest if test name describes the difference (and I guess in many cases that is what we have now). It would be good to document such tests in groups.
Yes, I don't think it makes much sense to document every subtest. Some are better documented as groups, many are just plain trivial (e.g. kms_addfb_basic), and for others it might be better to comment the exact test approach in-line in the code.
-Daniel
Quoted 427 lines
Thanks,
RadekQuoted 424 lines
Any, in my opinion documentation has to look pleasing, both in code and rendered, otherwise people will not look at it, not write it and not update it. Or worse, they stick to writing full comments, because that's the only thing that allows them to express what they want to document.
We need something much better imo than this patch series from that pov.
Thanks, Daniel
Quoted 412 lines
The documentation cannot be extracted from just comments, because associating them with the correct subtest name will then require doing pattern matching in the documentation generator, for subtests where the name is generated at runtime using
igt_subtest_f.v2: Rebase, change function name in commit message to match code
v3: Fix current documentation string tracking, add missing
va_end(Vinay)v4: Fix brainfart in
__igt_run_subtestSigned-off-by Petri Latvala <[email protected]>Acked-by Leo Li <[email protected]>Acked-by Arkadiusz Hiler <[email protected]>---
lib/igt_aux.c | 8 ++--
lib/igt_core.c | 149 +++++++++++++++++++++++++++++++++++++++++++++---------
---
lib/igt_core.h | 6 ++-3 files changed, 128 insertions(+), 35 deletions(-)lib/igt_aux.c +1
-1@@ -311,7 +311,7 @@ static void sig_handler(int i)*/ void igt_fork_signal_helper(void) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return;
/* We pick SIGCONT as it is a "safe" signal - if we send SIGCONT tolib/igt_aux.c +1
-1@@ -344,7 +344,7 @@ void igt_fork_signal_helper(void)*/ void igt_stop_signal_helper(void) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return;
igt_stop_helper(&signal_helper);lib/igt_aux.c +1
-1@@ -375,7 +375,7 @@ static void __attribute__((noreturn))shrink_helper_process(int fd, pid_t pid) */ void igt_fork_shrink_helper(int drm_fd) { -assert (!igt_only_list_subtests ()); +assert (!igt_only_collect_data ()); igt_require(igt_drop_caches_has(drm_fd, DROP_SHRINK_ALL)); igt_fork_helper(&shrink_helper)
shrink_helper_process(drm_fd, getppid());lib/igt_aux.c +1
-1@@ -473,7 +473,7 @@ void igt_stop_hang_detector(void) #else void igt_fork_hang_detector(int fd) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return; }lib/igt_core.c +0
-0@@ -99,7 +99,7 @@ * * To allow this i-g-t provides #igt_fixture code blocks for setup codeoutside
* of subtests and automatically skips the subtest code blocks themselves. For
- * special casesigt_only_list_subtests()is also provided. For setup code only
+ * special casesigt_only_collect_data()is also provided. For setup code only
* shared by a group of subtest encapsulate the #igt_fixture block and all the
* subtestest in a #igt_subtest_group block.
*lib/igt_core.c +0
-0@@ -253,9 +253,9 @@ static unsigned int exit_handler_count; const char *igt_interactive_debug;
/* subtests helpers */lib/igt_core.c +3
-3-static bool list_subtests = false; -static char *run_single_subtest =NULL ; -static bool run_single_subtest_found = false; +static char *single_subtest =NULL ; +static bool single_subtest_found = false; +static char *current_subtest_documentation =NULL ;static const char
*in_subtest= NULL;
static struct timespecsubtest_time;
staticclockid_tigt_clock= (clockid_t)-1;lib/igt_core.c +0
-0@@ -265,6 +265,13 @@ static bool in_atexit_handler = false; static enum {CONT = 0, SKIP, FAIL
}skip_subtests_henceforth= CONT;lib/igt_core.c +7
-0+static enum { +EXECUTE_ALL , +EXECUTE_SINGLE , +LIST_SUBTESTS , +DOCUMENT , +DOCUMENT_SINGLE +} runmode =EXECUTE_ALL ;
bool__igt_plain_output= false;lib/igt_core.c +2
-0@@ -277,6 +284,8 @@ bool test_child; enum { OPT_LIST_SUBTESTS, OPT_RUN_SUBTEST, +OPT_DOC_SUBTESTS , +OPT_DOC_SINGLE_SUBTEST , OPT_DESCRIPTION, OPT_DEBUG, OPT_INTERACTIVE_DEBUG,@@ -469,7 +478,7 @@ bool __igt_fixture(void) { assert(!in_fixture);lib/igt_core.c +1
-1-if (igt_only_list_subtests ()) +if (igt_only_collect_data ())return false;
if (skip_subtests_henceforth)lib/igt_core.c +1
-1@@ -563,7 +572,7 @@ static void low_mem_killer_disable(bool disable) bool igt_exit_called; static void common_exit_handler(int sig) { -if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) { low_mem_killer_disable(false); kick_fbcon(true); }@@ -583,7 +592,7 @@ static void print_version(void) { struct utsname uts;lib/igt_core.c +1
-1-if (list_subtests) +if (igt_only_collect_data ())return;
uname(&uts);lib/igt_core.c +0
-0@@ -599,6 +608,8 @@ static void print_usage(const char *help_str, bool output_on_stderr)
fprintf(f, "Usage: %s [OPTIONS]\n", command_str); fprintf(f, " --list-subtests\n"lib/igt_core.c +2
-0+ " --document-all-subtests\n" + " --document-subtest <pattern>\n"" --run-subtest <pattern>\n" " --debug[=log-domain]\n" " --interactive-debug[=domain]\n"
lib/igt_core.c +2
-0@@ -710,6 +721,8 @@ static int common_init(int *argc, char **argv, static struct option long_options[] = { {"list-subtests", 0, 0, OPT_LIST_SUBTESTS}, {"run-subtest", 1, 0, OPT_RUN_SUBTEST}, + {"document-all-subtests" ,0 ,0 ,OPT_DOC_SUBTESTS }, + {"document-subtest" ,1 ,0 ,OPT_DOC_SINGLE_SUBTEST }, {"help-description", 0, 0, OPT_DESCRIPTION}, {"debug", optional_argument, 0, OPT_DEBUG}, {"interactive-debug", optional_argument, 0,
OPT_INTERACTIVE_DEBUG},lib/igt_core.c +0
-0@@ -800,12 +813,24 @@ static int common_init(int *argc, char **argv, igt_log_domain_filter = strdup(optarg); break;case
OPT_LIST_SUBTESTS:lib/igt_core.c +2
-2-if (!run_single_subtest) - list_subtests = true; +if (runmode ==EXECUTE_ALL ) + runmode =LIST_SUBTESTS ;break;
caseOPT_RUN_SUBTEST:lib/igt_core.c +14
-2-if (!list_subtests) - run_single_subtest =strdup (optarg); +if (runmode ==EXECUTE_ALL ) { + runmode =EXECUTE_SINGLE ; + single_subtest =strdup (optarg); + } +break ; +case OPT_DOC_SUBTESTS : +if (runmode ==EXECUTE_ALL ) + runmode =DOCUMENT ; +break ; +case OPT_DOC_SINGLE_SUBTEST : +if (runmode ==EXECUTE_ALL ) { + runmode =DOCUMENT_SINGLE ; + single_subtest =strdup (optarg); + }break;
caseOPT_DESCRIPTION:
print_test_description();lib/igt_core.c +0
-0@@ -837,11 +862,11 @@ out: /* exit immediately if this test has no subtests and a subtest orthe
* list of subtests has been requested */
if (!test_with_subtests) {lib/igt_core.c +0
-2-if (run_single_subtest) { - igt_warn("Unknown subtest: %s\n",
run_single_subtest);lib/igt_core.c +1
-0+ if (runmode == EXECUTE_SINGLE || runmode ==
DOCUMENT_SINGLE) {lib/igt_core.c +1
-0+igt_warn ("Unknown subtest: %s\n" , single_subtest);
exit(IGT_EXIT_INVALID);
}lib/igt_core.c +1
-1-if (list_subtests) +if (runmode ==LIST_SUBTESTS || runmode ==DOCUMENT )
exit(IGT_EXIT_INVALID);
}lib/igt_core.c +0
-0@@ -849,7 +874,7 @@ out: /* exit with no error for -h/--help */ exit(ret == -1 ? 0 : IGT_EXIT_INVALID);lib/igt_core.c +1
-1-if (!list_subtests) { +if (!igt_only_collect_data ()) {
kick_fbcon(false);
kmsg(KERN_INFO "[IGT] %s: executing\n", command_str);print_version();lib/igt_core.c +0
-0@@ -957,16 +982,38 @@ bool __igt_run_subtest(const char *subtest_name) igt_exit(); }lib/igt_core.c +1
-1-if (list_subtests) { +if (runmode ==LIST_SUBTESTS ) {
printf("%s\n", subtest_name);
return false;
}lib/igt_core.c +17
-2-if (run_single_subtest) { -if (uwildmat (subtest_name, run_single_subtest) ==0 ) +if (runmode ==DOCUMENT ) { +if (current_subtest_documentation) { +printf ("%s:\n\n" , subtest_name); +printf ("%s" , current_subtest_documentation); +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + } +return false; + } + +if (runmode ==EXECUTE_SINGLE || runmode ==DOCUMENT_SINGLE ) { +bool stop = runmode ==DOCUMENT_SINGLE ; + +if (uwildmat (subtest_name, single_subtest)) { + single_subtest_found = true; + + if (runmode == DOCUMENT_SINGLE &&
current_subtest_documentation)lib/igt_core.c +1
-0+ printf("%s",
current_subtest_documentation);lib/igt_core.c +8
-0+ }else { + stop = true; + } + +free (current_subtest_documentation); + current_subtest_documentation =NULL ; + +if (stop)return false;
lib/igt_core.c +0
-2-else - run_single_subtest_found = true;}
if (skip_subtests_henceforth) {lib/igt_core.c +0
-0@@ -983,10 +1030,52 @@ bool __igt_run_subtest(const char *subtest_name) _igt_log_buffer_reset();
gettime(&subtest_time);
+
return (in_subtest=subtest_name);
}
/**
+ *igt_document_subtest:
+ * @documentation: documentation for the next subtest
+ *
+ * This function sets the documentation string for the next occurring subtest.
+ */lib/igt_core.c +14
-0+void igt_document_subtest (const char *documentation) +{ +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); + current_subtest_documentation =strdup (documentation); + } +} + +/** +* igt_document_subtest_f: +* @documentation: Documentation for the next subtest +* @...: format string and optional arguments +* +* This function sets the documentation string for the next occurring subtest.
+ *
+ * Likeigt_document_subtest(), but also accepts a printf format
+ * string instead of a static string.
+ */lib/igt_core.c +10
-0+__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...) +{ +int err; +va_list args; + +if (runmode ==DOCUMENT || runmode ==DOCUMENT_SINGLE ) { +free (current_subtest_documentation); +va_start (args, documentation); + err = vasprintf(¤t_subtest_documentation,documentation, args);
lib/igt_core.c +8
-0+va_end (args); +if (err <0 ) + current_subtest_documentation =NULL ; + } +} + + +/** *
igt_subtest_name:
*
* Returns: The name of the currently executed subtest or NULL if called fromlib/igt_core.c +0
-0@@ -998,14 +1087,14 @@ const char *igt_subtest_name(void) }
/**
- *igt_only_list_subtests:
+ *igt_only_collect_data:
*
- * Returns: Returns true if only subtest should be listed and any setup code
+ * Returns: Returns true if the running mode is only collecting data and any setup code
* must be skipped, false otherwise.
*/lib/igt_core.c +1
-1-bool igt_only_list_subtests (void ) +bool igt_only_collect_data (void ){
lib/igt_core.c +1
-1-return list_subtests; +return runmode !=EXECUTE_ALL && runmode !=EXECUTE_SINGLE ;}
void__igt_subtest_group_save(int *save)lib/igt_core.c +0
-0@@ -1059,7 +1148,7 @@ void igt_skip(const char *f, ...)
assert(!test_child);lib/igt_core.c +1
-1-if (!igt_only_list_subtests ()) { +if (!igt_only_collect_data ()) {
va_start(args, f);
vprintf(f, args);
va_end(args);lib/igt_core.c +0
-0@@ -1443,12 +1532,12 @@ void igt_exit(void) g_key_file_free(igt_key_file); #endiflib/igt_core.c +2
-2-if (run_single_subtest && !run_single_subtest_found) { -igt_warn ("Unknown subtest: %s\n" , run_single_subtest); +if (single_subtest && !single_subtest_found) { +igt_warn ("Unknown subtest: %s\n" , single_subtest);
exit(IGT_EXIT_INVALID);
}lib/igt_core.c +1
-1-if (igt_only_list_subtests ()) +if (igt_only_collect_data ())
exit(IGT_EXIT_SUCCESS);
/* Calling this without calling one of the above is a failure */lib/igt_core.c +1
-1@@ -2012,7 +2101,7 @@ bool igt_run_in_simulation(void)*/ void igt_skip_on_simulation(void) { -if (igt_only_list_subtests ()) +if (igt_only_collect_data ()) return;
if (!in_fixture && !in_subtest) {lib/igt_core.c +0
-0@@ -2087,7 +2176,7 @@ void igt_vlog(const char *domain, enum igt_log_level level, const char *format, program_name = command_str; #endiflib/igt_core.c +1
-1-if (list_subtests && level <=IGT_LOG_WARN ) +if (igt_only_collect_data () && level <=IGT_LOG_WARN )return;
if (vasprintf(&line, format, args)== -1)lib/igt_core.h +0
-0@@ -197,8 +197,12 @@ bool __igt_run_subtest(const char *subtest_name); #define igt_subtest_f(f...) \ __igt_subtest_f(igt_tokencat(__tmpchar, __LINE__), f)lib/igt_core.h +4
-0+void igt_document_subtest (const char *documentation); +__attribute__((format (printf,1 ,2 ))) +void igt_document_subtest_f (const char *documentation, ...); +const char
*igt_subtest_name(void);lib/igt_core.h +1
-1-bool igt_only_list_subtests (void ); +bool igt_only_collect_data (void );
void__igt_subtest_group_save(int *);
void__igt_subtest_group_restore(int);
--
2.9.3_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Signature · 7 lines
Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
PATCH v4 2/5 README: Describe the subtest documentation command line flags
In reply to Petri Latvala--- README | 5 +++++ 1 file changed, 5 insertions(+)
README +5 -0
@@ -32,6 +32,11 @@ tests/ be run. Some tests have futher options and these are detailed by using the --help option. + Tests with subtests will print a documentation string (if any) + with the --document-subtest option. The option + --document-all-subtests will print the subtest documentation + for all subtests that have it. + The test suite can be run using the run-tests.sh script available in the scripts directory. Piglit is used to run the tests and can either be installed from your distribution (if available), or can be
Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 2/5] README: Describe the subtest documentation command line flags
Quoted 11 lines · Petri Latvala
Signed-off-by Petri Latvala <[email protected]>--- README | 5 +++++ 1 file changed, 5 insertions(+)README +0
-0@@ -32,6 +32,11 @@ tests/ be run. Some tests have futher options and these are detailed by using
README tests/ · line 42
Quoted 10 lines
README +5
-0the --help option. + Tests with subtests will print a documentation string (if any) + with the --document-subtest option. The option + --document-all-subtests will print the subtest documentation + for all subtests that have it. + The test suite can be run using the run-tests.sh script available in the scripts directory. Piglit is used to run the tests and can either be installed from your distribution (if available), or can be
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
PATCH v4 3/5 docs: Include subtest documentation
In reply to Petri LatvalaA simple and naive format: Double newline denotes paragraph change, otherwise insert subtest documentation into the generated docs as-is.
--- docs/reference/intel-gpu-tools/Makefile.am | 6 ++++++ 1 file changed, 6 insertions(+)
docs/reference/intel-gpu-tools/Makefile.am +6 -0
@@ -56,6 +56,12 @@ xml/igt_test_programs_%_description.xml: $(TESTLISTS) for subtest in $$subtest_list; do \ echo "<member>" >> $@; \ echo "$$subtest" | perl -pe 's/\b$(KEYWORDS)\b/<acronym>\1<\/acronym>/g' >> $@; \ + subtest_doc=`./$$testprog --document-subtest $$subtest`; \ + if [ -n "$$subtest_doc" ]; then \ + echo "<para><![CDATA[" >> $@; \ + echo "$$subtest_doc" | sed ':a;N;$$!ba;s,\n\n,]]></para><para><![CDATA[,g'>> $@; \ + echo "]]></para>" >> $@; \ + fi; \ echo "</member>" >> $@; \ done; \ echo "</simplelist>" >> $@; \
Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
PATCH v4 4/5 testdisplay: Handle subtest documentation flags
In reply to Petri Latvalatestdisplay has no subtests so hook them to existing subtest handling.
--- tests/testdisplay.c | 2 ++ 1 file changed, 2 insertions(+)
tests/testdisplay.c +2 -0
@@ -623,6 +623,8 @@ int main(int argc, char **argv)struct option long_opts[] = { {"list-subtests" ,0 ,0 ,SUBTEST_OPTS }, {"run-subtest" ,1 ,0 ,SUBTEST_OPTS }, + {"document-all-subtests" ,0 ,0 ,SUBTEST_OPTS }, + {"document-subtest" ,1 ,0 ,SUBTEST_OPTS }, {"help-description" ,0 ,0 ,HELP_DESCRIPTION }, {"help" ,0 ,0 ,'h' }, {"yb" ,0 ,0 , Yb_OPT},
Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 4/5] testdisplay: Handle subtest documentation flags
Quoted 12 lines · Petri Latvala
testdisplay has no subtests so hook them to existing subtest handling.
Signed-off-by Petri Latvala <[email protected]>--- tests/testdisplay.c | 2 ++ 1 file changed, 2 insertions(+)tests/testdisplay.c +0
-0
tests/testdisplay.c int main(int argc, char **argv) · line 630
Quoted 8 lines
tests/testdisplay.c +2
-0@@ -623,6 +623,8 @@ int main(int argc, char **argv)struct option long_opts[] = { {"list-subtests" ,0 ,0 ,SUBTEST_OPTS }, {"run-subtest" ,1 ,0 ,SUBTEST_OPTS }, + {"document-all-subtests" ,0 ,0 ,SUBTEST_OPTS }, + {"document-subtest" ,1 ,0 ,SUBTEST_OPTS }, {"help-description" ,0 ,0 ,HELP_DESCRIPTION }, {"help" ,0 ,0 ,'h' }, {"yb" ,0 ,0 , Yb_OPT},
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
PATCH v4 5/5 igt_command_line.sh: Test subtest documentation flag handling
In reply to Petri Latvala--- tests/igt_command_line.sh | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-)
tests/igt_command_line.sh +11 -1
@@ -102,7 +102,17 @@ for test in $TESTLIST; do fi fi + # check --document-all-subtests handling + echo " Checking subtest documentation..." + DOCS=`./$test --document-all-subtests` + RET=$? + + if [ $RET -ne 0 -a $RET -ne 79 ]; then + fail $test + fi + # check invalid subtest handling echo " Checking invalid subtest handling..." - ./$test --run-subtest invalid-subtest > /dev/null 2>&1 && fail $test + ./$test --run-subtest invalid-subtest > /dev/null 2>&1 && fail "$test --run-subtest invalid" + ./$test --document-subtest invalid-subtest > /dev/null 2>&1 && fail "$test --document-subtest invalid" done
Signature · 6 lines
2.9.3 _______________________________________________ Intel-gfx mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Re: [PATCH i-g-t 5/5] igt_command_line.sh: Test subtest documentation flag handling
Quoted 18 lines · Petri Latvala
Signed-off-by Petri Latvala <[email protected]>--- tests/igt_command_line.sh | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-)tests/igt_command_line.sh +5
-0@@ -102,7 +102,17 @@ for test in $TESTLIST; do fi fi + # check --document-all-subtests handling + echo " Checking subtest documentation..." + DOCS=`./$test --document-all-subtests` + RET=$? +
tests/igt_command_line.sh for test in $TESTLIST; do · line 118
Quoted 10 lines
tests/igt_command_line.sh +6
-1+ if [ $RET -ne 0 -a $RET -ne 79 ]; then + fail $test + fi + # check invalid subtest handling echo " Checking invalid subtest handling..." - ./$test --run-subtest invalid-subtest > /dev/null 2>&1 && fail $test + ./$test --run-subtest invalid-subtest > /dev/null 2>&1 && fail "$test --run-subtest invalid" + ./$test --document-subtest invalid-subtest > /dev/null 2>&1 && fail "$test --document-subtest invalid" done
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Patchwork
CI✓ Fi.CI.BAT: success for Subtest documentation (rev2)
In reply to Petri Latvala== Series Details ==
== Series Details ==
Series: Subtest documentation (rev2)
URL : https://patchwork.freedesktop.org/series/28605/
State : success
== Summary ==
IGT patchset tested on top of latest successful build c129026622accef6f54c0cfb0dc55e930cfa60b5 igt: add syncobj_basic.
with latest DRM-Tip kernel build CI_DRM_2943ed9143385873 drm-tip: 2017y-08m-10d-09h-37m-54s UTC integration manifest
Test kms_cursor_legacy:
Subgroup basic-busy-flip-before-cursor-atomic:
pass -> FAIL (fi-snb-2600) fdo#100215fdo#100215 https://bugs.freedesktop.org/show_bug.cgi?id=100215
fi-bdw-5557u total:279 pass:268 dwarn:0 dfail:0 fail:0 skip:11 time:447s fi-bdw-gvtdvm total:279 pass:265 dwarn:0 dfail:0 fail:0 skip:14 time:425s fi-blb-e6850 total:279 pass:224 dwarn:1 dfail:0 fail:0 skip:54 time:355s fi-bsw-n3050 total:279 pass:243 dwarn:0 dfail:0 fail:0 skip:36 time:487s fi-bxt-j4205 total:279 pass:260 dwarn:0 dfail:0 fail:0 skip:19 time:486s fi-byt-j1900 total:279 pass:254 dwarn:1 dfail:0 fail:0 skip:24 time:528s fi-byt-n2820 total:279 pass:250 dwarn:1 dfail:0 fail:0 skip:28 time:509s fi-glk-2a total:279 pass:260 dwarn:0 dfail:0 fail:0 skip:19 time:583s fi-hsw-4770 total:279 pass:263 dwarn:0 dfail:0 fail:0 skip:16 time:430s fi-hsw-4770r total:279 pass:263 dwarn:0 dfail:0 fail:0 skip:16 time:414s fi-ilk-650 total:279 pass:229 dwarn:0 dfail:0 fail:0 skip:50 time:427s fi-ivb-3520m total:279 pass:261 dwarn:0 dfail:0 fail:0 skip:18 time:508s fi-ivb-3770 total:279 pass:261 dwarn:0 dfail:0 fail:0 skip:18 time:479s fi-kbl-7500u total:279 pass:261 dwarn:0 dfail:0 fail:0 skip:18 time:463s fi-kbl-7560u total:279 pass:269 dwarn:0 dfail:0 fail:0 skip:10 time:569s fi-kbl-r total:279 pass:261 dwarn:0 dfail:0 fail:0 skip:18 time:577s fi-pnv-d510 total:279 pass:223 dwarn:1 dfail:0 fail:0 skip:55 time:530s fi-skl-6260u total:279 pass:269 dwarn:0 dfail:0 fail:0 skip:10 time:444s fi-skl-6700k total:279 pass:261 dwarn:0 dfail:0 fail:0 skip:18 time:643s fi-skl-6770hq total:279 pass:269 dwarn:0 dfail:0 fail:0 skip:10 time:464s fi-skl-gvtdvm total:279 pass:266 dwarn:0 dfail:0 fail:0 skip:13 time:424s fi-skl-x1585l total:279 pass:269 dwarn:0 dfail:0 fail:0 skip:10 time:491s fi-snb-2520m total:279 pass:251 dwarn:0 dfail:0 fail:0 skip:28 time:549s fi-snb-2600 total:279 pass:248 dwarn:0 dfail:0 fail:2 skip:29 time:416s
== Logs ==
For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_52/
_______________________________________________
Intel-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/intel-gfx