threads / patch / 53487

patchcommit-slab-decl.h: fix define gaurds

Subject: [PATCH] commit-slab-decl.h: fix define gaurds

## tl;dr

6 messages between May 16, 2020 and May 18, 2020. Diffs are folded; open one to read it.

replies: 5people: 3as markdown or json

Abhishek Kumar· May 16, 2020, 17:28 UTC · lore

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.

Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com>
---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Show changes to commit-slab-decl.h +3 −3
diff --git a/commit-slab-decl.h b/commit-slab-decl.h
index adc7b46c83..bfbed1516a 100644
--- a/commit-slab-decl.h
+++ b/commit-slab-decl.h
@@ -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.26.0
Junio C Hamano· May 17, 2020, 15:44 UTC · re: Abhishek Kumar · lore

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

Abhishek Kumar <abhishekkumar8222@gmail.com> writes:
That's "guard" ;-)
> 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.
Show 23 quoted lines
> Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com>
> ---
>  commit-slab-decl.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/commit-slab-decl.h b/commit-slab-decl.h
> index adc7b46c83..bfbed1516a 100644
> --- a/commit-slab-decl.h
> +++ b/commit-slab-decl.h
> @@ -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 */
Abhishek Kumar· May 18, 2020, 14:30 UTC · re: Abhishek Kumar · lore

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

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.
Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com>
---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Show changes to commit-slab-decl.h +3 −3
diff --git a/commit-slab-decl.h b/commit-slab-decl.h
index adc7b46c83..bfbed1516a 100644
--- a/commit-slab-decl.h
+++ b/commit-slab-decl.h
@@ -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.26.0
Junio C Hamano· May 18, 2020, 17:12 UTC · re: Abhishek Kumar · lore

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

Abhishek Kumar <abhishekkumar8222@gmail.com> writes:
> 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 <abhishekkumar8222@gmail.com>
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.

Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 commit-slab-decl.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Show changes to commit-slab-decl.h +3 −3
diff --git a/commit-slab-decl.h b/commit-slab-decl.h
index adc7b46c83..bfbed1516a 100644
--- a/commit-slab-decl.h
+++ b/commit-slab-decl.h
@@ -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.27.0-rc0
Eric Sunshine· May 18, 2020, 17:29 UTC · re: Junio C Hamano · lore

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

On Mon, May 18, 2020 at 1:14 PM Junio C Hamano <gitster@pobox.com> wrote:
Show 6 quoted lines
> From: Abhishek Kumar <abhishekkumar8222@gmail.com>
> 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/
Show 8 quoted 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.
>
> Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano· May 18, 2020, 17:32 UTC · re: Eric Sunshine · lore

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

Eric Sunshine <sunshine@sunshineco.com> writes:
Show 9 quoted lines
> On Mon, May 18, 2020 at 1:14 PM Junio C Hamano <gitster@pobox.com> wrote:
>> From: Abhishek Kumar <abhishekkumar8222@gmail.com>
>> 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.
Show 8 quoted 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.
>>
>> Signed-off-by: Abhishek Kumar <abhishekkumar8222@gmail.com>
>> Signed-off-by: Junio C Hamano <gitster@pobox.com>

← back to recent threads