[PATCH] Improve file header comment in generated files
Chris Johns
chrisj at rtems.org
Sun Jan 24 23:30:00 UTC 2021
Looks good. Thank you.
Chris
On 23/1/21 2:06 am, Sebastian Huber wrote:
> ---
> cpukit/doxygen/appl-config.h | 10 +++++++---
> cpukit/include/rtems.h | 10 +++++++---
> cpukit/include/rtems/config.h | 10 +++++++---
> cpukit/include/rtems/io.h | 10 +++++++---
> cpukit/include/rtems/rtems/attr.h | 10 +++++++---
> cpukit/include/rtems/rtems/config.h | 10 +++++++---
> cpukit/include/rtems/rtems/event.h | 10 +++++++---
> cpukit/include/rtems/rtems/modes.h | 10 +++++++---
> cpukit/include/rtems/rtems/object.h | 10 +++++++---
> cpukit/include/rtems/rtems/options.h | 10 +++++++---
> cpukit/include/rtems/rtems/part.h | 10 +++++++---
> cpukit/include/rtems/rtems/status.h | 10 +++++++---
> cpukit/include/rtems/rtems/timer.h | 10 +++++++---
> cpukit/include/rtems/rtems/types.h | 10 +++++++---
> cpukit/include/rtems/score/basedefs.h | 10 +++++++---
> testsuites/validation/tc-message-construct-errors.c | 10 +++++++---
> testsuites/validation/tc-part-performance.c | 10 +++++++---
> testsuites/validation/tc-task-construct-errors.c | 10 +++++++---
> testsuites/validation/ts-performance-0.c | 10 +++++++---
> testsuites/validation/ts-validation-0.c | 10 +++++++---
> 20 files changed, 140 insertions(+), 60 deletions(-)
>
> diff --git a/cpukit/doxygen/appl-config.h b/cpukit/doxygen/appl-config.h
> index 4774972600..092e02ccca 100644
> --- a/cpukit/doxygen/appl-config.h
> +++ b/cpukit/doxygen/appl-config.h
> @@ -33,11 +33,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /**
> diff --git a/cpukit/include/rtems.h b/cpukit/include/rtems.h
> index d1b1452000..29716e9eaf 100644
> --- a/cpukit/include/rtems.h
> +++ b/cpukit/include/rtems.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/if/header */
> diff --git a/cpukit/include/rtems/config.h b/cpukit/include/rtems/config.h
> index 3fda60289f..cc54a25d9e 100644
> --- a/cpukit/include/rtems/config.h
> +++ b/cpukit/include/rtems/config.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/config/if/header */
> diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h
> index 92ffb6d51b..445f24cb78 100644
> --- a/cpukit/include/rtems/io.h
> +++ b/cpukit/include/rtems/io.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/io/if/header */
> diff --git a/cpukit/include/rtems/rtems/attr.h b/cpukit/include/rtems/rtems/attr.h
> index bf35a2c4af..baea36aa9f 100644
> --- a/cpukit/include/rtems/rtems/attr.h
> +++ b/cpukit/include/rtems/rtems/attr.h
> @@ -38,11 +38,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/attr/if/header */
> diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
> index cd1791ebae..76a4a758b9 100644
> --- a/cpukit/include/rtems/rtems/config.h
> +++ b/cpukit/include/rtems/rtems/config.h
> @@ -39,11 +39,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/config/if/header-2 */
> diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h
> index 78d84213f7..8aa115762d 100644
> --- a/cpukit/include/rtems/rtems/event.h
> +++ b/cpukit/include/rtems/rtems/event.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/event/if/header */
> diff --git a/cpukit/include/rtems/rtems/modes.h b/cpukit/include/rtems/rtems/modes.h
> index 8c3379d909..b711b119b6 100644
> --- a/cpukit/include/rtems/rtems/modes.h
> +++ b/cpukit/include/rtems/rtems/modes.h
> @@ -38,11 +38,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/mode/if/header */
> diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
> index 3f879a169b..aee6d5c3ed 100644
> --- a/cpukit/include/rtems/rtems/object.h
> +++ b/cpukit/include/rtems/rtems/object.h
> @@ -38,11 +38,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/object/if/header */
> diff --git a/cpukit/include/rtems/rtems/options.h b/cpukit/include/rtems/rtems/options.h
> index d8431c151d..60d90f997e 100644
> --- a/cpukit/include/rtems/rtems/options.h
> +++ b/cpukit/include/rtems/rtems/options.h
> @@ -38,11 +38,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/option/if/header */
> diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
> index aeb4de64c5..5a747f428b 100644
> --- a/cpukit/include/rtems/rtems/part.h
> +++ b/cpukit/include/rtems/rtems/part.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/part/if/header */
> diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h
> index 9b32a85205..35752442d9 100644
> --- a/cpukit/include/rtems/rtems/status.h
> +++ b/cpukit/include/rtems/rtems/status.h
> @@ -39,11 +39,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/status/if/header */
> diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h
> index 3d454e39ec..fe22eef39d 100644
> --- a/cpukit/include/rtems/rtems/timer.h
> +++ b/cpukit/include/rtems/rtems/timer.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/timer/if/header */
> diff --git a/cpukit/include/rtems/rtems/types.h b/cpukit/include/rtems/rtems/types.h
> index 32b45113c8..a058eedea1 100644
> --- a/cpukit/include/rtems/rtems/types.h
> +++ b/cpukit/include/rtems/rtems/types.h
> @@ -38,11 +38,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/type/if/header */
> diff --git a/cpukit/include/rtems/score/basedefs.h b/cpukit/include/rtems/score/basedefs.h
> index 0081dbfbe4..d017ffa96a 100644
> --- a/cpukit/include/rtems/score/basedefs.h
> +++ b/cpukit/include/rtems/score/basedefs.h
> @@ -40,11 +40,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> /* Generated from spec:/rtems/basedefs/if/header */
> diff --git a/testsuites/validation/tc-message-construct-errors.c b/testsuites/validation/tc-message-construct-errors.c
> index d71e427b63..f2fa30638b 100644
> --- a/testsuites/validation/tc-message-construct-errors.c
> +++ b/testsuites/validation/tc-message-construct-errors.c
> @@ -37,11 +37,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> #ifdef HAVE_CONFIG_H
> diff --git a/testsuites/validation/tc-part-performance.c b/testsuites/validation/tc-part-performance.c
> index 46f48c7bf5..5c3148edcc 100644
> --- a/testsuites/validation/tc-part-performance.c
> +++ b/testsuites/validation/tc-part-performance.c
> @@ -37,11 +37,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> #ifdef HAVE_CONFIG_H
> diff --git a/testsuites/validation/tc-task-construct-errors.c b/testsuites/validation/tc-task-construct-errors.c
> index 4dfd12dbb8..bbaaf04ba2 100644
> --- a/testsuites/validation/tc-task-construct-errors.c
> +++ b/testsuites/validation/tc-task-construct-errors.c
> @@ -37,11 +37,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> #ifdef HAVE_CONFIG_H
> diff --git a/testsuites/validation/ts-performance-0.c b/testsuites/validation/ts-performance-0.c
> index cc61547ef9..1fb15ecfce 100644
> --- a/testsuites/validation/ts-performance-0.c
> +++ b/testsuites/validation/ts-performance-0.c
> @@ -37,11 +37,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> #ifdef HAVE_CONFIG_H
> diff --git a/testsuites/validation/ts-validation-0.c b/testsuites/validation/ts-validation-0.c
> index 1b5ea795cd..c56bd5ea81 100644
> --- a/testsuites/validation/ts-validation-0.c
> +++ b/testsuites/validation/ts-validation-0.c
> @@ -37,11 +37,15 @@
> * worded better please post a report or patch to an RTEMS mailing list
> * or raise a bug report:
> *
> - * https://docs.rtems.org/branches/master/user/support/bugs.html
> + * https://www.rtems.org/bugs.html
> *
> - * For information on updating and regenerating please refer to:
> + * For information on updating and regenerating please refer to the How-To
> + * section in the Software Requirements Engineering chapter of the
> + * RTEMS Software Engineering manual. The manual is provided as a part of
> + * a release. For development sources please refer to the online
> + * documentation at:
> *
> - * https://docs.rtems.org/branches/master/eng/req/howto.html
> + * https://docs.rtems.org
> */
>
> #ifdef HAVE_CONFIG_H
>
More information about the devel
mailing list