Skip to contentSkip to conversation

commit-slab-decl.h: fix define gaurds

PATCH Superseded Abhishek Kumar 3 participants 6 messages May 16, 2020 – May 18, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 commit-slab-decl.h: fix define gaurds

commit-slab was split into commit-slab-decl and commit-slab-impl header files by a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19). The define guards for commit-slab-decl stll use "COMMIT_SLAB_HDR_H", which no longer matches the file name. Let's fix this.

---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
commit-slab-decl.h +3 -3
index adc7b46c83..bfbed1516a 100644
@@ -1,5 +1,5 @@
-#ifndef COMMIT_SLAB_HDR_H
-#define COMMIT_SLAB_HDR_H
+#ifndef COMMIT_SLAB_DECL_H
+#define COMMIT_SLAB_DECL_H
 
 /* allocate ~512kB at once, allowing for malloc overhead */
 #ifndef COMMIT_SLAB_SIZE
@@ -40,4 +40,4 @@ elemtype *slabname## _peek(struct slabname *s, const struct commit *c)
 	declare_commit_slab(slabname, elemtype); \
 	declare_commit_slab_prototypes(slabname, elemtype)
 
-#endif /* COMMIT_SLAB_HDR_H */
+#endif /* COMMIT_SLAB_DECL_H */
Signature · 1 line
2.26.0
#1 lore raw

Abhishek Kumar <[email protected]> writes:

That's "guard" ;-)

Quoted 4 lines

commit-slab was split into commit-slab-decl and commit-slab-impl header files by a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19). The define guards for commit-slab-decl stll use "COMMIT_SLAB_HDR_H", which no longer matches the file name. Let's fix this.

It would have been helpful to explain that the split did not break anything because the other half of the split started using a new and different proprocessor macro before saying "Let's fix".

It would have been "broken" that needs "fixing" if two headers inherited the use of the same _HDR_H preprocessor macro, of course.

The patch obviously looks good.

Quoted 23 lines
---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
commit-slab-decl.h +3 -3
index adc7b46c83..bfbed1516a 100644
@@ -1,5 +1,5 @@
-#ifndef COMMIT_SLAB_HDR_H
-#define COMMIT_SLAB_HDR_H
+#ifndef COMMIT_SLAB_DECL_H
+#define COMMIT_SLAB_DECL_H
 
 /* allocate ~512kB at once, allowing for malloc overhead */
 #ifndef COMMIT_SLAB_SIZE
@@ -40,4 +40,4 @@ elemtype *slabname## _peek(struct slabname *s, const struct commit *c)
 	declare_commit_slab(slabname, elemtype); \
 	declare_commit_slab_prototypes(slabname, elemtype)
 
-#endif /* COMMIT_SLAB_HDR_H */
+#endif /* COMMIT_SLAB_DECL_H */
#2 lore raw

PATCH v2 1/1 commit-slab-decl.h: fix define guards

In reply to Abhishek Kumar

a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19) split commit-slab into commit-slab-decl and commit-slab-impl header files. The define guards for commit-slab-decl still use "COMMIT_SLAB_HDR_H". Fortunately, commit-slab-impl introduced its own macro, "COMMIT_SLAB_IMPL_H". Otherwise, the code would have been broken by not including commit-slab-impl.

Let's correct the define guards for commit-slab-decl to match file name.

---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
commit-slab-decl.h +3 -3
index adc7b46c83..bfbed1516a 100644
@@ -1,5 +1,5 @@
-#ifndef COMMIT_SLAB_HDR_H
-#define COMMIT_SLAB_HDR_H
+#ifndef COMMIT_SLAB_DECL_H
+#define COMMIT_SLAB_DECL_H
 
 /* allocate ~512kB at once, allowing for malloc overhead */
 #ifndef COMMIT_SLAB_SIZE
@@ -40,4 +40,4 @@ elemtype *slabname## _peek(struct slabname *s, const struct commit *c)
 	declare_commit_slab(slabname, elemtype); \
 	declare_commit_slab_prototypes(slabname, elemtype)
 
-#endif /* COMMIT_SLAB_HDR_H */
+#endif /* COMMIT_SLAB_DECL_H */
Signature · 1 line
2.26.0
#3 lore raw

Re: [PATCH v2] commit-slab-decl.h: fix define guards

Quoted 2 lines · Abhishek Kumar

a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19) split commit-slab
...

I've rephrased the log message a bit more before queuing, since I did not find many hits for "define guards" but the search engine found quite a common use of "include guard".

Thanks.

-- >8 --
From: Abhishek Kumar <[email protected]>
Subject: [PATCH] commit-slab-decl.h: update include guard

When a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19) split commit-slab.h into commit-slab-decl.h and commit-slab-impl.h header files, commit-slab-decl.h were left use "COMMIT_SLAB_HDR_H", while commit-slab-impl.h gained its own macro, "COMMIT_SLAB_IMPL_H".

As these two files use different include guards, there is nothing broken, but let's update commit-slab-decl.h to match the convention to name the include guard after the filename.

---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
commit-slab-decl.h +3 -3
index adc7b46c83..bfbed1516a 100644
@@ -1,5 +1,5 @@
-#ifndef COMMIT_SLAB_HDR_H
-#define COMMIT_SLAB_HDR_H
+#ifndef COMMIT_SLAB_DECL_H
+#define COMMIT_SLAB_DECL_H
 
 /* allocate ~512kB at once, allowing for malloc overhead */
 #ifndef COMMIT_SLAB_SIZE
@@ -40,4 +40,4 @@ elemtype *slabname## _peek(struct slabname *s, const struct commit *c)
 	declare_commit_slab(slabname, elemtype); \
 	declare_commit_slab_prototypes(slabname, elemtype)
 
-#endif /* COMMIT_SLAB_HDR_H */
+#endif /* COMMIT_SLAB_DECL_H */
Signature · 1 line
2.27.0-rc0
#4 lore raw

Re: [PATCH v2] commit-slab-decl.h: fix define guards

Quoted 6 lines · Junio C Hamano

From: Abhishek Kumar <[email protected]>
Subject: [PATCH] commit-slab-decl.h: update include guard

When a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19) split commit-slab.h into commit-slab-decl.h and commit-slab-impl.h header files, commit-slab-decl.h were left use "COMMIT_SLAB_HDR_H", while

s/were left use/was left using/

Quoted 8 lines

commit-slab-impl.h gained its own macro, "COMMIT_SLAB_IMPL_H".

As these two files use different include guards, there is nothing broken, but let's update commit-slab-decl.h to match the convention to name the include guard after the filename.

#5 lore raw

Re: [PATCH v2] commit-slab-decl.h: fix define guards

Quoted 9 lines · Eric Sunshine
Quoted 6 lines · Junio C Hamano

From: Abhishek Kumar <[email protected]>
Subject: [PATCH] commit-slab-decl.h: update include guard

When a9f1f1f9f8 ("commit-slab.h: code split", 2018-05-19) split commit-slab.h into commit-slab-decl.h and commit-slab-impl.h header files, commit-slab-decl.h were left use "COMMIT_SLAB_HDR_H", while

s/were left use/was left using/

Thanks, I meant to say "left to use" actually.

Quoted 8 lines
Quoted 8 lines

commit-slab-impl.h gained its own macro, "COMMIT_SLAB_IMPL_H".

As these two files use different include guards, there is nothing broken, but let's update commit-slab-decl.h to match the convention to name the include guard after the filename.