diff mbox series

[avr] Adjust comment headers

Message ID cc874c2f-c2fd-47a6-8d4d-d6a57256fbfd@gjlay.de
State New
Headers show
Series [avr] Adjust comment headers | expand

Commit Message

Georg-Johann Lay Sept. 2, 2024, 6:49 a.m. UTC
Atmel is no more the AVR manufacturer.  This patch removes the
manufacturer from the file headers.

Ok for trunk?

Johann

--

Comments

Georg-Johann Lay Sept. 2, 2024, 8:10 a.m. UTC | #1
Am 02.09.24 um 09:18 schrieb Jan Dubiec:
> On 02.09.2024 08:49, Georg-Johann Lay wrote:
>> Atmel is no more the AVR manufacturer.  This patch removes the
>> manufacturer from the file headers.
>>
>> Ok for trunk?
> In this context, microcontroller is one word: 
> https://en.wikipedia.org/wiki/Microcontroller.
> 
> /J.D.

Thank you.  Here is an updated patch.

Johann
Denis Chertykov Sept. 2, 2024, 7:11 p.m. UTC | #2
пн, 2 сент. 2024 г. в 12:10, Georg-Johann Lay <avr@gjlay.de>:
>
> Am 02.09.24 um 09:18 schrieb Jan Dubiec:
> > On 02.09.2024 08:49, Georg-Johann Lay wrote:
> >> Atmel is no more the AVR manufacturer.  This patch removes the
> >> manufacturer from the file headers.
> >>
> >> Ok for trunk?
> > In this context, microcontroller is one word:
> > https://en.wikipedia.org/wiki/Microcontroller.
> >
> > /J.D.
>
> Thank you.  Here is an updated patch.

Please apply.

Denis

>
> Johann
Gerald Pfeifer Nov. 16, 2024, 12:19 p.m. UTC | #3
On Mon, 2 Sep 2024, Georg-Johann Lay wrote:
> Atmel is no more the AVR manufacturer.  This patch removes the
> manufacturer from the file headers.

We also have

  <li>AVR
  <br>Manufacturer: Atmel
  <br><a href="https://www.microchip.com/en-us/products/microcontrollers-and-microprocessors/8-bit-mcus/avr-mcus">AVR documentation</a>
  </li>

in https://gcc.gnu.org/readings.html . 

How should that be changed? (Simply drop the Atmel line?)

Gerald
Jan Dubiec Nov. 18, 2024, 5:53 a.m. UTC | #4
On 16.11.2024 13:19, Gerald Pfeifer wrote:
[...]
> How should that be changed? (Simply drop the Atmel line?)
I am not sure what you mean, but I think "Atmel" should be replaced with 
"Microchip" because other devices have manufacturers listed.

https://www.microchip.com/pdf/mchp_to_acquire_atmel.pdf
Georg-Johann Lay Nov. 18, 2024, 8:03 a.m. UTC | #5
Am 16.11.24 um 13:19 schrieb Gerald Pfeifer:
> On Mon, 2 Sep 2024, Georg-Johann Lay wrote:
>> Atmel is no more the AVR manufacturer.  This patch removes the
>> manufacturer from the file headers.
> 
> We also have
> 
>    <li>AVR
>    <br>Manufacturer: Atmel
>    <br><a href="https://www.microchip.com/en-us/products/microcontrollers-and-microprocessors/8-bit-mcus/avr-mcus">AVR documentation</a>
>    </li>
> 
> in https://gcc.gnu.org/readings.html .
> 
> How should that be changed? (Simply drop the Atmel line?)
> 
> Gerald

Hi, I'd just drop the "Atmel".  That's what I did in all the
other places.

Maybe instead of "AVR" something like "AVR 8-bit microcontrollers"
makes it clearer what AVR means in this context.

Johann
Georg-Johann Lay Nov. 19, 2024, 11:39 a.m. UTC | #6
Am 18.11.24 um 09:03 schrieb Georg-Johann Lay:
> Am 16.11.24 um 13:19 schrieb Gerald Pfeifer:
>> On Mon, 2 Sep 2024, Georg-Johann Lay wrote:
>>> Atmel is no more the AVR manufacturer.  This patch removes the
>>> manufacturer from the file headers.
>>
>> We also have
>>
>>    <li>AVR
>>    <br>Manufacturer: Atmel
>>    <br><a 
>> href="https://www.microchip.com/en-us/products/microcontrollers-and-microprocessors/8-bit-mcus/avr-mcus">AVR documentation</a>
>>    </li>
>>
>> in https://gcc.gnu.org/readings.html .
>>
>> How should that be changed? (Simply drop the Atmel line?)
>>
>> Gerald
> 
> Hi, I'd just drop the "Atmel".  That's what I did in all the
> other places.
> 
> Maybe instead of "AVR" something like "AVR 8-bit microcontrollers"
> makes it clearer what AVR means in this context.
> 
> Johann

...and maybe what's also of interest are the instruction set manual (pdf)

https://ww1.microchip.com/downloads/en/DeviceDoc/AVR-InstructionSet-Manual-DS40002198.pdf

and the avr-gcc wiki that describes parts of the ABI:

https://gcc.gnu.org/wiki/avr-gcc

Johann
Gerald Pfeifer Nov. 25, 2024, 9:25 a.m. UTC | #7
On Mon, 18 Nov 2024, Georg-Johann Lay wrote:
>> We also have
>> 
>>    <li>AVR
>>    <br>Manufacturer: Atmel
>>    <br><a
>>    href="https://www.microchip.com/en-us/products/microcontrollers-and-microprocessors/8-bit-mcus/avr-mcus">AVR
>>    documentation</a>
>>    </li>
>> 
>> in https://gcc.gnu.org/readings.html .
> Hi, I'd just drop the "Atmel".  That's what I did in all the other 
> places.

Thanks, I'll make this change.

> Maybe instead of "AVR" something like "AVR 8-bit microcontrollers"
> makes it clearer what AVR means in this context.

We don't have something this for other architectures, though why not 
start? Will add this, too.

On Tue, 19 Nov 2024, Georg-Johann Lay wrote:
> ...and maybe what's also of interest are the instruction set manual (pdf)
> 
> https://ww1.microchip.com/downloads/en/DeviceDoc/AVR-InstructionSet-Manual-DS40002198.pdf
> 
> and the avr-gcc wiki that describes parts of the ABI:
> 
> https://gcc.gnu.org/wiki/avr-gcc

I'll add the latter; on the former (and deep links) I'm a bit more 
hesitant since they keep breaking and should be findable from the general 
site.

Gerald
diff mbox series

Patch

    AVR: Remove "Atmel" from header comment.
    
    gcc/
            * config/avr/avr.h: Remove "Atmel" from header comment.
            * config/avr/avr.cc: Same.
            * config/avr/avr.md: Same.
            * config/avr/avr.opt: Same.
            * config/avr/avr-dimode.md: Same.
            * config/avr/avr-fixed.md: Same.
            * config/avr/constraints.md: Same.
            * config/avr/predicates.md: Same.
            * config/avr/avr-log.cc: Same.
            * config/avr/avrlibc.h: Same.
            * config/avr/specs.h: Same.
            * common/config/avr/avr-common.cc: Same.
            * doc/install.texi: Same.
            * config/avr/avr-arch.h: Adjust header comment.
            * config/avr/avr-c.cc: Same.
            * config/avr/avr-mcus.def: Same.
            * config/avr/avr-modes.def: Same.
            * config/avr/avr-passes.cc: Same.
            * config/avr/avr-passes.def: Same.
            * config/avr/avr-protos.h: Same.
            * config/avr/avrlibc.h: Same.
            * config/avr/driver-avr.cc: Same.
            * config/avr/elf.h: Same.
            * config/avr/gen-avr-mmcu-specs.cc: Same.
            * config/avr/gen-avr-mmcu-texi.cc: Same.

diff --git a/gcc/common/config/avr/avr-common.cc b/gcc/common/config/avr/avr-common.cc
index fdf130f1e1a..f1b2620a5a0 100644
--- a/gcc/common/config/avr/avr-common.cc
+++ b/gcc/common/config/avr/avr-common.cc
@@ -1,4 +1,4 @@ 
-/* Common hooks for ATMEL AVR.
+/* Common hooks for AVR 8-bit micro controllers.
    Copyright (C) 1998-2024 Free Software Foundation, Inc.
 
    This file is part of GCC.
diff --git a/gcc/config/avr/avr-arch.h b/gcc/config/avr/avr-arch.h
index 69e8db1fcfe..79682edcd23 100644
--- a/gcc/config/avr/avr-arch.h
+++ b/gcc/config/avr/avr-arch.h
@@ -1,5 +1,4 @@ 
-/* Definitions of types that are used to store AVR architecture and
-   device information.
+/* Device information for AVR 8-bit micro controllers.
    Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay (avr@gjlay.de)
 
diff --git a/gcc/config/avr/avr-c.cc b/gcc/config/avr/avr-c.cc
index ca484f26132..04e30dab6d1 100644
--- a/gcc/config/avr/avr-c.cc
+++ b/gcc/config/avr/avr-c.cc
@@ -1,4 +1,5 @@ 
-/* Copyright (C) 2009-2024 Free Software Foundation, Inc.
+/* Code for the C/C++ front end for AVR 8-bit micro controllers.
+   Copyright (C) 2009-2024 Free Software Foundation, Inc.
    Contributed by Anatoly Sokolov (aesok@post.ru)
 
    This file is part of GCC.
diff --git a/gcc/config/avr/avr-dimode.md b/gcc/config/avr/avr-dimode.md
index c357213e211..47a9aa77dfb 100644
--- a/gcc/config/avr/avr-dimode.md
+++ b/gcc/config/avr/avr-dimode.md
@@ -1,5 +1,5 @@ 
 ;;   Machine description for GNU compiler,
-;;   for Atmel AVR micro controllers.
+;;   for AVR 8-bit micro controllers.
 ;;   Copyright (C) 1998-2024 Free Software Foundation, Inc.
 ;;   Contributed by Georg Lay (avr@gjlay.de)
 ;;
diff --git a/gcc/config/avr/avr-fixed.md b/gcc/config/avr/avr-fixed.md
index 911b8b2cd67..b3a8447a2ba 100644
--- a/gcc/config/avr/avr-fixed.md
+++ b/gcc/config/avr/avr-fixed.md
@@ -1,5 +1,5 @@ 
 ;;   This file contains instructions that support fixed-point operations
-;;   for Atmel AVR micro controllers.
+;;   for AVR 8-bit micro controllers.
 ;;   Copyright (C) 2012-2024 Free Software Foundation, Inc.
 ;;
 ;;   Contributed by Sean D'Epagnier  (sean@depagnier.com)
diff --git a/gcc/config/avr/avr-log.cc b/gcc/config/avr/avr-log.cc
index d702c5f3fd8..9e7bdba0002 100644
--- a/gcc/config/avr/avr-log.cc
+++ b/gcc/config/avr/avr-log.cc
@@ -1,4 +1,4 @@ 
-/* Subroutines for log output for Atmel AVR back end.
+/* Subroutines for log output for AVR 8-bit micro controllers.
    Copyright (C) 2011-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay (avr@gjlay.de)
 
diff --git a/gcc/config/avr/avr-mcus.def b/gcc/config/avr/avr-mcus.def
index 068875a2c60..27898ebd583 100644
--- a/gcc/config/avr/avr-mcus.def
+++ b/gcc/config/avr/avr-mcus.def
@@ -1,4 +1,4 @@ 
-/* AVR MCUs.
+/* Information on supported AVR 8-bit micro controllers.
    Copyright (C) 2009-2024 Free Software Foundation, Inc.
 
    This file is part of GCC.
diff --git a/gcc/config/avr/avr-modes.def b/gcc/config/avr/avr-modes.def
index b756beae9a0..7e505a02469 100644
--- a/gcc/config/avr/avr-modes.def
+++ b/gcc/config/avr/avr-modes.def
@@ -1,4 +1,5 @@ 
-/* Copyright (C) 2012-2024 Free Software Foundation, Inc.
+/* Extra machine modes for AVR 8-bit micro ocntrollers.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
 
    This file is part of GCC.
 
diff --git a/gcc/config/avr/avr-passes.cc b/gcc/config/avr/avr-passes.cc
index 8a71b57ada1..ee1c99de5a3 100644
--- a/gcc/config/avr/avr-passes.cc
+++ b/gcc/config/avr/avr-passes.cc
@@ -1,4 +1,4 @@ 
-/* Functions and methods for avr specific passes registered in avr-passes.def.
+/* Support for avr-passes.def for AVR 8-bit micro controllers.
    Copyright (C) 2024 Free Software Foundation, Inc.
 
    This file is part of GCC.
diff --git a/gcc/config/avr/avr-passes.def b/gcc/config/avr/avr-passes.def
index cd89d673727..745abce03c7 100644
--- a/gcc/config/avr/avr-passes.def
+++ b/gcc/config/avr/avr-passes.def
@@ -1,4 +1,4 @@ 
-/* Description of target passes for AVR.
+/* Description of target passes for AVR 8-bit micro controllers.
    Copyright (C) 2016-2024 Free Software Foundation, Inc. */
 
 /* This file is part of GCC.
diff --git a/gcc/config/avr/avr-protos.h b/gcc/config/avr/avr-protos.h
index d6f4abbac66..13592091ffb 100644
--- a/gcc/config/avr/avr-protos.h
+++ b/gcc/config/avr/avr-protos.h
@@ -1,5 +1,4 @@ 
-/* Prototypes for exported functions defined in avr.cc
-   
+/* Prototypes for tm_p.h for AVR 8-bit micro controllers.
    Copyright (C) 2000-2024 Free Software Foundation, Inc.
    Contributed by Denis Chertykov (chertykov@gmail.com)
 
diff --git a/gcc/config/avr/avr.cc b/gcc/config/avr/avr.cc
index 079db62695d..a9aecfe729e 100644
--- a/gcc/config/avr/avr.cc
+++ b/gcc/config/avr/avr.cc
@@ -1,4 +1,4 @@ 
-/* Subroutines for insn-output.cc for ATMEL AVR micro controllers
+/* Subroutines for insn-output.cc for AVR 8-bit micro controllers
    Copyright (C) 1998-2024 Free Software Foundation, Inc.
    Contributed by Denis Chertykov (chertykov@gmail.com)
 
diff --git a/gcc/config/avr/avr.h b/gcc/config/avr/avr.h
index 56b7f39b834..e25a2c7a3b3 100644
--- a/gcc/config/avr/avr.h
+++ b/gcc/config/avr/avr.h
@@ -1,5 +1,5 @@ 
 /* Definitions of target machine for GNU compiler,
-   for ATMEL AVR at90s8515, ATmega103/103L, ATmega603/603L microcontrollers.
+   for AVR 8-bit micro controllers.
    Copyright (C) 1998-2024 Free Software Foundation, Inc.
    Contributed by Denis Chertykov (chertykov@gmail.com)
 
diff --git a/gcc/config/avr/avr.md b/gcc/config/avr/avr.md
index 520f1fe41a2..e4e083fa8d8 100644
--- a/gcc/config/avr/avr.md
+++ b/gcc/config/avr/avr.md
@@ -1,5 +1,5 @@ 
 ;;   Machine description for GNU compiler,
-;;   for ATMEL AVR micro controllers.
+;;   for AVR 8-bit micro controllers.
 ;;   Copyright (C) 1998-2024 Free Software Foundation, Inc.
 ;;   Contributed by Denis Chertykov (chertykov@gmail.com)
 
diff --git a/gcc/config/avr/avr.opt b/gcc/config/avr/avr.opt
index 444ed7edb26..51f773f10f5 100644
--- a/gcc/config/avr/avr.opt
+++ b/gcc/config/avr/avr.opt
@@ -1,4 +1,4 @@ 
-; Options for the ATMEL AVR port of the compiler.
+; Options for AVR 8-bit micro controllers.
 
 ; Copyright (C) 2005-2024 Free Software Foundation, Inc.
 ;
diff --git a/gcc/config/avr/avrlibc.h b/gcc/config/avr/avrlibc.h
index fb4ffedcc91..09de42efe16 100644
--- a/gcc/config/avr/avrlibc.h
+++ b/gcc/config/avr/avrlibc.h
@@ -1,5 +1,4 @@ 
-/* Definitions of target machine for the GNU compiler collection
-   for Atmel AVR micro controller if configured for AVR-Libc.
+/* Definitions for AVR 8-bit micro controllers if configured for AVR-LibC.
    Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay (avr@gjlay.de)
 
diff --git a/gcc/config/avr/constraints.md b/gcc/config/avr/constraints.md
index 963e23a4d9e..88df39617b0 100644
--- a/gcc/config/avr/constraints.md
+++ b/gcc/config/avr/constraints.md
@@ -1,4 +1,4 @@ 
-;; Constraint definitions for ATMEL AVR micro controllers.
+;; Constraint definitions for AVR 8-bit micro controllers.
 ;; Copyright (C) 2006-2024 Free Software Foundation, Inc.
 ;;
 ;; This file is part of GCC.
diff --git a/gcc/config/avr/driver-avr.cc b/gcc/config/avr/driver-avr.cc
index 92e875a66c9..7291c6fa7ae 100644
--- a/gcc/config/avr/driver-avr.cc
+++ b/gcc/config/avr/driver-avr.cc
@@ -1,4 +1,4 @@ 
-/* Subroutines for the gcc driver.
+/* Subroutines for the gcc driver for AVR 8-bit micro controllers.
    Copyright (C) 2009-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay <avr@gjlay.de>
 
diff --git a/gcc/config/avr/elf.h b/gcc/config/avr/elf.h
index 0112aa3d432..f6b9d8e6183 100644
--- a/gcc/config/avr/elf.h
+++ b/gcc/config/avr/elf.h
@@ -1,4 +1,5 @@ 
-/* Copyright (C) 2011-2024 Free Software Foundation, Inc.
+/* Overrides for elfos.h for AVR 8-bit micro controllers.
+   Copyright (C) 2011-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay (avr@gjlay.de)
 
    This file is part of GCC.
diff --git a/gcc/config/avr/gen-avr-mmcu-specs.cc b/gcc/config/avr/gen-avr-mmcu-specs.cc
index bb94bea12b0..8f10d954956 100644
--- a/gcc/config/avr/gen-avr-mmcu-specs.cc
+++ b/gcc/config/avr/gen-avr-mmcu-specs.cc
@@ -1,4 +1,5 @@ 
-/* Copyright (C) 1998-2024 Free Software Foundation, Inc.
+/* Build device-specs for AVR 8-bit micro controllers.
+   Copyright (C) 1998-2024 Free Software Foundation, Inc.
    Contributed by Joern Rennecke
 
    This file is part of GCC.
diff --git a/gcc/config/avr/gen-avr-mmcu-texi.cc b/gcc/config/avr/gen-avr-mmcu-texi.cc
index 70aa430902e..c65433b8def 100644
--- a/gcc/config/avr/gen-avr-mmcu-texi.cc
+++ b/gcc/config/avr/gen-avr-mmcu-texi.cc
@@ -1,4 +1,5 @@ 
-/* Copyright (C) 2012-2024 Free Software Foundation, Inc.
+/* Build texi documentation for option -mmcu for AVR 8-bit micro controllers.
+   Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay (avr@gjlay.de)
 
    This file is part of GCC.
diff --git a/gcc/config/avr/predicates.md b/gcc/config/avr/predicates.md
index b21acbe323f..d666492e4a0 100644
--- a/gcc/config/avr/predicates.md
+++ b/gcc/config/avr/predicates.md
@@ -1,4 +1,4 @@ 
-;; Predicate definitions for ATMEL AVR micro controllers.
+;; Predicate definitions for AVR 8-bit micro controllers.
 ;; Copyright (C) 2006-2024 Free Software Foundation, Inc.
 ;;
 ;; This file is part of GCC.
diff --git a/gcc/config/avr/specs.h b/gcc/config/avr/specs.h
index 0ccc37b8844..3e5edf8708a 100644
--- a/gcc/config/avr/specs.h
+++ b/gcc/config/avr/specs.h
@@ -1,4 +1,4 @@ 
-/* Specs definitions for Atmel AVR back end.
+/* Specs definitions for AVR 8-bit micro controllers.
 
    Copyright (C) 2012-2024 Free Software Foundation, Inc.
    Contributed by Georg-Johann Lay (avr@gjlay.de)
diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index f871227f684..6a773dd3deb 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -4005,7 +4005,7 @@  GNAT 4.6, 4.9 or 5 release branches are known to succeed.
 @end html
 @anchor{avr}
 @heading avr
-ATMEL AVR-family micro controllers.  These are used in embedded
+AVR 8-bit micro controllers.  These are used in embedded
 applications.  There are no standard Unix configurations.
 @ifnothtml
 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler