diff mbox series

libio: Remove comment in <stdio.h>

Message ID 7e2e9d58-53cd-40be-853a-6e1776cdd1c3@jguk.org
State New
Headers show
Series libio: Remove comment in <stdio.h> | expand

Commit Message

Jonny Grant Oct. 28, 2023, 10:37 p.m. UTC
Hello

Please find attached patch created against latest git.

Regards, Jonny

Comments

Adhemerval Zanella Netto Oct. 30, 2023, 12:36 p.m. UTC | #1
On 28/10/23 19:37, Jonny Grant wrote:
> Hello
> 
> Please find attached patch created against latest git.
> 
> Regards, Jonny

For new header the current practice is to add a one-line comment to
describe it, so I think it would be better to follow it on old header
changes.
Jonny Grant Nov. 23, 2023, 7:54 p.m. UTC | #2
On 30/10/2023 12:36, Adhemerval Zanella Netto wrote:
> 
> 
> On 28/10/23 19:37, Jonny Grant wrote:
>> Hello
>>
>> Please find attached patch created against latest git.
>>
>> Regards, Jonny
> 
> For new header the current practice is to add a one-line comment to
> describe it, so I think it would be better to follow it on old header
> changes.

Hi Adhemerval

May I clarify, this file has this after the copyright & license. I considered that was enough. Do you mean I should put that at the top of the file as well?

/*
 *	ISO C99 Standard: 7.19 Input/output	<stdio.h>
 */

With kind regards, Jonny
Adhemerval Zanella Netto Nov. 24, 2023, 12:29 p.m. UTC | #3
On 23/11/23 16:54, Jonny Grant wrote:
> 
> 
> On 30/10/2023 12:36, Adhemerval Zanella Netto wrote:
>>
>>
>> On 28/10/23 19:37, Jonny Grant wrote:
>>> Hello
>>>
>>> Please find attached patch created against latest git.
>>>
>>> Regards, Jonny
>>
>> For new header the current practice is to add a one-line comment to
>> describe it, so I think it would be better to follow it on old header
>> changes.
> 
> Hi Adhemerval
> 
> May I clarify, this file has this after the copyright & license. I considered that was enough. Do you mean I should put that at the top of the file as well?
> 
> /*
>  *	ISO C99 Standard: 7.19 Input/output	<stdio.h>
>  */
> 
> With kind regards, Jonny

Yes.  Our current practice is always add one-line comment on a new file, even
the installed ones, with a brief description.
Jonny Grant Nov. 24, 2023, 1:37 p.m. UTC | #4
Adhemerval,

Updated patch attached for review.

Kind regards, Jonny
diff mbox series

Patch

From fad8ca3bb29bb1da7167677e9fe14185aab103ba Mon Sep 17 00:00:00 2001
From: Jonathan Grant <jg@jguk.org>
Date: Sat, 28 Oct 2023 23:34:31 +0100
Subject: [PATCH] libio: Remove comment in <stdio.h>

Signed-off-by: Jonathan Grant <jg@jguk.org>
---
 libio/stdio.h | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/libio/stdio.h b/libio/stdio.h
index a640e9beb5..ac36a43f74 100644
--- a/libio/stdio.h
+++ b/libio/stdio.h
@@ -1,5 +1,4 @@ 
-/* Define ISO C stdio on top of C++ iostreams.
-   Copyright (C) 1991-2023 Free Software Foundation, Inc.
+/* Copyright (C) 1991-2023 Free Software Foundation, Inc.
    Copyright The GNU Toolchain Authors.
    This file is part of the GNU C Library.
 
-- 
2.39.2