threads / patch / 60809

patch, 3 partsComment style fixes

Subject: [PATCH 0/3] Comment style fixes

## tl;dr

5 messages between Jan 29, 2024 and Jan 30, 2024. Diffs are folded; open one to read it.

replies: 4people: 2as markdown or json

Junio C Hamano· Jan 29, 2024, 20:28 UTC · lore

Among comments in the traditional /* single liner */ ones, our reviews seem to have missed a few // comments. While they are not illegal per-se, they look out of place mixed with the /* ... */ style comments, which is the prevailing style used in this project.

Fix those small number of style violations in our own code; files with borrowed code that have // comments as the prevalent style are left untouched.

Junio C Hamano (3):
  builtin/worktree: comment style fixes
  merge-ort.c: comment style fix
  reftable/pq_test: comment style fix

 builtin/worktree.c | 10 +++++-----
 merge-ort.c        |  2 +-
 reftable/pq_test.c |  2 +-
 3 files changed, 7 insertions(+), 7 deletions(-)

-- 
2.43.0-440-gb50a608ba2

Junio C Hamano· Jan 29, 2024, 20:28 UTC · re: Junio C Hamano · lore

[PATCH 1/3] builtin/worktree: comment style fixes

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 builtin/worktree.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Show changes to builtin/worktree.c +5 −5

diff --git a/builtin/worktree.c b/builtin/worktree.c
index 6d7da11746..9c76b62b02 100644
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -848,21 +848,21 @@ static int add(int ac, const char **av, const char *prefix)
 		const char *s = worktree_basename(path, &n);
 		new_branch = xstrndup(s, n);
 	} else if (opts.orphan) {
-		// No-op
+		; /* no-op */
 	} else if (opts.detach) {
-		// Check HEAD
+		/* Check HEAD */
 		if (!strcmp(branch, "HEAD"))
 			can_use_local_refs(&opts);
 	} else if (ac < 2 && new_branch) {
-		// DWIM: Infer --orphan when repo has no refs.
+		/* DWIM: Infer --orphan when repo has no refs. */
 		opts.orphan = dwim_orphan(&opts, !!opt_track, 0);
 	} else if (ac < 2) {
-		// DWIM: Guess branch name from path.
+		/* DWIM: Guess branch name from path. */
 		const char *s = dwim_branch(path, &new_branch);
 		if (s)
 			branch = s;
 
-		// DWIM: Infer --orphan when repo has no refs.
+		/* DWIM: Infer --orphan when repo has no refs. */
 		opts.orphan = (!s) && dwim_orphan(&opts, !!opt_track, 1);
 	} else if (ac == 2) {
 		struct object_id oid;

-- 
2.43.0-440-gb50a608ba2

Junio C Hamano· Jan 29, 2024, 20:28 UTC · re: Junio C Hamano · lore

[PATCH 3/3] reftable/pq_test: comment style fix

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 reftable/pq_test.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to reftable/pq_test.c +1 −1

diff --git a/reftable/pq_test.c b/reftable/pq_test.c
index 011b5c7502..c202eff848 100644
--- a/reftable/pq_test.c
+++ b/reftable/pq_test.c
@@ -60,7 +60,7 @@ static void test_pq(void)
 		if (last) {
 			EXPECT(strcmp(last, rec->u.ref.refname) < 0);
 		}
-		// this is names[i], so don't dealloc.
+		/* this is names[i], so don't dealloc. */
 		last = rec->u.ref.refname;
 		rec->u.ref.refname = NULL;
 		reftable_record_release(rec);

-- 
2.43.0-440-gb50a608ba2

Junio C Hamano· Jan 29, 2024, 20:28 UTC · re: Junio C Hamano · lore

[PATCH 2/3] merge-ort.c: comment style fix

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 merge-ort.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to merge-ort.c +1 −1

diff --git a/merge-ort.c b/merge-ort.c
index 77ba7f3020..cb83449d7f 100644
--- a/merge-ort.c
+++ b/merge-ort.c
@@ -2641,7 +2641,7 @@ static void apply_directory_rename_modifications(struct merge_options *opt,
 			oidcpy(&ci->stages[i].oid, null_oid());
 		}
 
-		// Now we want to focus on new_ci, so reassign ci to it
+		/* Now we want to focus on new_ci, so reassign ci to it. */
 		ci = new_ci;
 	}

-- 
2.43.0-440-gb50a608ba2

Patrick Steinhardt· Jan 30, 2024, 06:10 UTC · re: Junio C Hamano · lore

Re: [PATCH 0/3] Comment style fixes

On Mon, Jan 29, 2024 at 12:28:36PM -0800, Junio C Hamano wrote:

Show 8 quoted lines

> Among comments in the traditional /* single liner */ ones, our
> reviews seem to have missed a few // comments.  While they are not
> illegal per-se, they look out of place mixed with the /* ... */
> style comments, which is the prevailing style used in this project.
> 
> Fix those small number of style violations in our own code; files
> with borrowed code that have // comments as the prevalent style are
> left untouched.

These changes look obviously good to me, thanks!

Patrick