Skip to contentSkip to conversation

perf config: Refine error message to eliminate confusion

PATCH Applied Like Xu 3 participants 3 messages Sep 24, 2021 perf events

lore
Share & tools
lore

Like Xu

author
#0 lore raw

PATCH 1/1 perf config: Refine error message to eliminate confusion

From: Like Xu <[email protected]>

If there is no configuration file at first, the user can write any pair of "key.subkey=value" to the newly created configuration file, while value validation against a valid configurable key is *deferred* until the next execution or the implied execution of "perf config ... ".

For example:

 $ rm ~/.perfconfig
 $ perf config call-graph.dump-size=65529
 $ cat ~/.perfconfig
 # this file is auto-generated.
 [call-graph]
 	dump-size = 65529
 $ perf config call-graph.dump-size=2048
 callchain: Incorrect stack dump size (max 65528): 65529
 Error: wrong config key-value pair call-graph.dump-size=65529

The user might expect that the second value 2048 is valid and can be updated to the configuration file, but the error message is very confusing because the first value 65529 is not reported as an error during the last configuration.

It is recommended not to change the current behavior of delayed validation (as more effort is needed), but to refine the original error message to *clearly indicate* that the cause of the error is the configuration file.

---
 tools/perf/util/config.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/util/config.c +1 -1
index 4fb5e90d7a57..60ce5908c664 100644
@@ -801,7 +801,7 @@ int perf_config_set(struct perf_config_set *set,
 				  section->name, item->name);
 			ret = fn(key, value, data);
 			if (ret < 0) {
-				pr_err("Error: wrong config key-value pair %s=%s\n",
+				pr_err("Error in the given config file: wrong config key-value pair %s=%s\n",
 				       key, value);
 				/*
 				 * Can't be just a 'break', as perf_config_set__for_each_entry()
Signature · 1 line
2.32.0
reviewer Acked-by on v1 1/1
#1 lore raw
Quoted 26 lines · Like Xu

From: Like Xu <[email protected]>

If there is no configuration file at first, the user can write any pair of "key.subkey=value" to the newly created configuration file, while value validation against a valid configurable key is *deferred* until the next execution or the implied execution of "perf config ... ".

For example:

 $ rm ~/.perfconfig
 $ perf config call-graph.dump-size=65529
 $ cat ~/.perfconfig
 # this file is auto-generated.
 [call-graph]
        dump-size = 65529
 $ perf config call-graph.dump-size=2048
 callchain: Incorrect stack dump size (max 65528): 65529
 Error: wrong config key-value pair call-graph.dump-size=65529

The user might expect that the second value 2048 is valid and can be updated to the configuration file, but the error message is very confusing because the first value 65529 is not reported as an error during the last configuration.

Quoted 6 lines

It is recommended not to change the current behavior of delayed validation (as more effort is needed), but to refine the original error message to *clearly indicate* that the cause of the error is the configuration file.

Thanks,
Ian

Quoted 20 lines
---
 tools/perf/util/config.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/util/config.c +1 -2
index 4fb5e90d7a57..60ce5908c664 100644
@@ -801,7 +801,7 @@ int perf_config_set(struct perf_config_set *set,
                                  section->name, item->name);
                        ret = fn(key, value, data);
                        if (ret < 0) {
-                               pr_err("Error: wrong config key-value pair %s=%s\n",
+                               pr_err("Error in the given config file: wrong config key-value pair %s=%s\n",
                                       key, value);
                                /*
                                 * Can't be just a 'break', as perf_config_set__for_each_entry()
--

2.32.0

maintainer Applied
#2 lore raw

Em Fri, Sep 24, 2021 at 08:08:07AM -0700, Ian Rogers escreveu:

Quoted 27 lines · Like Xu
Quoted 26 lines

From: Like Xu <[email protected]>

If there is no configuration file at first, the user can write any pair of "key.subkey=value" to the newly created configuration file, while value validation against a valid configurable key is *deferred* until the next execution or the implied execution of "perf config ... ".

For example:

 $ rm ~/.perfconfig
 $ perf config call-graph.dump-size=65529
 $ cat ~/.perfconfig
 # this file is auto-generated.
 [call-graph]
        dump-size = 65529
 $ perf config call-graph.dump-size=2048
 callchain: Incorrect stack dump size (max 65528): 65529
 Error: wrong config key-value pair call-graph.dump-size=65529

The user might expect that the second value 2048 is valid and can be updated to the configuration file, but the error message is very confusing because the first value 65529 is not reported as an error during the last configuration.

Quoted 8 lines
Quoted 6 lines

It is recommended not to change the current behavior of delayed validation (as more effort is needed), but to refine the original error message to *clearly indicate* that the cause of the error is the configuration file.

Thanks, applied.

- Arnaldo

Quoted 23 lines

Thanks,
Ian

Quoted 20 lines
---
 tools/perf/util/config.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/util/config.c +1 -2
index 4fb5e90d7a57..60ce5908c664 100644
@@ -801,7 +801,7 @@ int perf_config_set(struct perf_config_set *set,
                                  section->name, item->name);
                        ret = fn(key, value, data);
                        if (ret < 0) {
-                               pr_err("Error: wrong config key-value pair %s=%s\n",
+                               pr_err("Error in the given config file: wrong config key-value pair %s=%s\n",
                                       key, value);
                                /*
                                 * Can't be just a 'break', as perf_config_set__for_each_entry()
--

2.32.0

Signature · 1 line
- Arnaldo