Skip to contentSkip to conversation

doc: use glob terminology

PATCH Superseded [email protected] 2 participants 6 messages Apr 12, 2020 – May 19, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: use glob terminology

From: Jerin Jacob <[email protected]>

Globbing is the word used on fnmatch man page. Use globing terminology accross dpdk repo for shell pattern.

---
 devtools/check-includes.sh       | 2 +-
 lib/librte_eal/include/rte_log.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
devtools/check-includes.sh +1 -1
index 3629ab4c7..743e77675 100755
@@ -23,7 +23,7 @@
 # PEDANTIC_CFLAGS, PEDANTIC_CXXFLAGS and PEDANTIC_CPPFLAGS provide strict
 # C/C++ compilation flags.
 #
-# IGNORE contains a list of shell patterns matching files (relative to the
+# IGNORE contains a list of globbing matching files (relative to the
 # include directory) to avoid. It is set by default to known DPDK headers
 # which must not be included on their own.
 #
lib/librte_eal/include/rte_log.h +1 -1
index a497e195d..05761a3b6 100644
@@ -158,7 +158,7 @@ __rte_experimental
 bool rte_log_can_log(uint32_t logtype, uint32_t loglevel);
 
 /**
- * Set the log level for a given type based on shell pattern.
+ * Set the log level for a given type based on globbing.
  *
  * @param pattern
  *   The match pattern identifying the log type.
Signature · 1 line
2.25.1
#1 lore raw

PATCH v2 1/1 doc: use glob terminology

From: Jerin Jacob <[email protected]>

Glob is the terminology used in fnmatch man page. Use glob terminology across DPDK for shell pattern.

---
v2:
- Fix typo

 devtools/check-includes.sh       | 2 +-
 lib/librte_eal/include/rte_log.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
devtools/check-includes.sh +1 -1
index 3629ab4c7..ca49cd722 100755
@@ -23,7 +23,7 @@
 # PEDANTIC_CFLAGS, PEDANTIC_CXXFLAGS and PEDANTIC_CPPFLAGS provide strict
 # C/C++ compilation flags.
 #
-# IGNORE contains a list of shell patterns matching files (relative to the
+# IGNORE contains a list of glob matching files (relative to the
 # include directory) to avoid. It is set by default to known DPDK headers
 # which must not be included on their own.
 #
lib/librte_eal/include/rte_log.h +1 -1
index a497e195d..fa60177c0 100644
@@ -158,7 +158,7 @@ __rte_experimental
 bool rte_log_can_log(uint32_t logtype, uint32_t loglevel);
 
 /**
- * Set the log level for a given type based on shell pattern.
+ * Set the log level for a given type based on glob.
  *
  * @param pattern
  *   The match pattern identifying the log type.

--
2.25.1

#2 lore raw

12/04/2020 17:04, [email protected]:

Quoted 16 lines
devtools/check-includes.sh +1 -1
@@ -23,7 +23,7 @@
 # PEDANTIC_CFLAGS, PEDANTIC_CXXFLAGS and PEDANTIC_CPPFLAGS provide strict
 # C/C++ compilation flags.
 #
-# IGNORE contains a list of shell patterns matching files (relative to the
+# IGNORE contains a list of glob matching files (relative to the
 # include directory) to avoid. It is set by default to known DPDK headers
 # which must not be included on their own.
 #
lib/librte_eal/include/rte_log.h +0 -0
index a497e195d..fa60177c0 100644

lib/librte_eal/include/rte_log.h __rte_experimental · line 164

Quoted 8 lines
lib/librte_eal/include/rte_log.h +1 -1
@@ -158,7 +158,7 @@ __rte_experimental
 bool rte_log_can_log(uint32_t logtype, uint32_t loglevel);
 
 /**
- * Set the log level for a given type based on shell pattern.
+ * Set the log level for a given type based on glob.
  *
  * @param pattern
  *   The match pattern identifying the log type.

My comment on v1 was sent at the same time as this v2. Pasting it here:

"match pattern" can be replaced with "globbing pattern".

I think there are few other places which can be improved.

I see this one in lib/librte_eal/common/eal_common_log.c:
glob (file match) pattern
I suggest "globbing pattern"

And "Glob match string option" -> "Globbing pattern option"

#3 lore raw

PATCH v3 1/1 doc: use glob terminology

In reply to [email protected]

From: Jerin Jacob <[email protected]>

Glob is the terminology used in fnmatch man page. Use glob terminology across DPDK for shell pattern.

---

v3:
- Address Thomas's comments
http://patches.dpdk.org/patch/68225/

v2:
- Fix typo

 devtools/check-includes.sh             | 2 +-
 lib/librte_eal/common/eal_common_log.c | 4 ++--
 lib/librte_eal/include/rte_log.h       | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)
devtools/check-includes.sh +1 -1
index 3629ab4c7..749b9b26d 100755
@@ -23,7 +23,7 @@
 # PEDANTIC_CFLAGS, PEDANTIC_CXXFLAGS and PEDANTIC_CPPFLAGS provide strict
 # C/C++ compilation flags.
 #
-# IGNORE contains a list of shell patterns matching files (relative to the
+# IGNORE contains a list of globbing patterns matching files (relative to the
 # include directory) to avoid. It is set by default to known DPDK headers
 # which must not be included on their own.
 #
lib/librte_eal/common/eal_common_log.c +2 -2
index d7a5f9b64..8835c8fff 100644
@@ -29,7 +29,7 @@ struct rte_eal_opt_loglevel {
 	TAILQ_ENTRY(rte_eal_opt_loglevel) next;
 	/** Compiled regular expression obtained from the option */
 	regex_t re_match;
-	/** Glob match string option */
+	/** Globbing pattern option */
 	char *pattern;
 	/** Log level value obtained from the option */
 	uint32_t level;
@@ -207,7 +207,7 @@ int rte_log_save_regexp(const char *regex, int tmp)
 	return rte_log_save_level(tmp, regex, NULL);
 }
 
-/* set log level based on glob (file match) pattern */
+/* set log level based on globbing pattern */
 int
 rte_log_set_level_pattern(const char *pattern, uint32_t level)
 {
lib/librte_eal/include/rte_log.h +2 -2
index c020a3d7e..1789ede56 100644
@@ -158,10 +158,10 @@ __rte_experimental
 bool rte_log_can_log(uint32_t logtype, uint32_t loglevel);
 
 /**
- * Set the log level for a given type based on shell pattern.
+ * Set the log level for a given type based on globbing pattern.
  *
  * @param pattern
- *   The match pattern identifying the log type.
+ *   The globbing pattern identifying the log type.
  * @param level
  *   The level to be set.
  * @return

--
2.26.2

#5 lore raw
In reply to [email protected]

12/04/2020 16:40, [email protected]:

Quoted 6 lines

From: Jerin Jacob <[email protected]>

Globbing is the word used on fnmatch man page. Use globing terminology accross dpdk repo for shell pattern.

[...]

lib/librte_eal/include/rte_log.h __rte_experimental · line 164

Quoted 7 lines
lib/librte_eal/include/rte_log.h +1 -1
- * Set the log level for a given type based on shell pattern.
+ * Set the log level for a given type based on globbing.
  *
  * @param pattern
  *   The match pattern identifying the log type.

"match pattern" can be replaced with "globbing pattern".

I think there are few other places which can be improved.

I see this one in lib/librte_eal/common/eal_common_log.c:
glob (file match) pattern
I suggest "globbing pattern"

And "Glob match string option" -> "Globbing pattern option"