From 29def2e3934455535a0a3b4f70816a6eeae4ea99 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Tue, 6 Oct 2020 09:38:21 +0200 Subject: content: Improve automatically generated warning --- rtemsspec/content.py | 13 ++++-- rtemsspec/tests/test_applconfig.py | 26 +++++++---- rtemsspec/tests/test_interface.py | 13 ++++-- rtemsspec/tests/test_specdoc.py | 13 ++++-- rtemsspec/tests/test_validation.py | 91 ++++++++++++++++++++++++++------------ 5 files changed, 108 insertions(+), 48 deletions(-) diff --git a/rtemsspec/content.py b/rtemsspec/content.py index ee7b2b3d..c9c33d53 100644 --- a/rtemsspec/content.py +++ b/rtemsspec/content.py @@ -159,12 +159,17 @@ def _add_context(_content: "Content") -> Iterator[None]: _SPECIAL_BLOCK = re.compile(r"^( *\* | *[0-9]+\. | +)") _AUTOMATICALLY_GENERATED_WARNING = [ - "This file was automatically generated. Do not edit it manually.", - "Please have a look at", + "Do not manually edit this file. It is part of the RTEMS quality process", + "and was automatically generated.", "", - "https://docs.rtems.org/branches/master/eng/req/howto.html", + "If you find something that needs to be fixed or worded better please", + "post a report to an RTEMS mailing list or raise a bug report:", + "", + "https://docs.rtems.org/branches/master/user/support/bugs.html", "", - "for information how to maintain and re-generate this file.", + "For information on updating and regenerating please refer to:", + "", + "https://docs.rtems.org/branches/master/eng/req/howto.html", ] diff --git a/rtemsspec/tests/test_applconfig.py b/rtemsspec/tests/test_applconfig.py index be45f4eb..c7fb9f6e 100644 --- a/rtemsspec/tests/test_applconfig.py +++ b/rtemsspec/tests/test_applconfig.py @@ -48,12 +48,17 @@ def test_applconfig(tmpdir): .. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -.. This file was automatically generated. Do not edit it manually. -.. Please have a look at +.. Do not manually edit this file. It is part of the RTEMS quality process +.. and was automatically generated. .. -.. https://docs.rtems.org/branches/master/eng/req/howto.html +.. If you find something that needs to be fixed or worded better please +.. post a report to an RTEMS mailing list or raise a bug report: +.. +.. https://docs.rtems.org/branches/master/user/support/bugs.html .. -.. for information how to maintain and re-generate this file. +.. For information on updating and regenerating please refer to: +.. +.. https://docs.rtems.org/branches/master/eng/req/howto.html group name ========== @@ -403,12 +408,17 @@ NOTES: */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html * - * for information how to maintain and re-generate this file. + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ /** diff --git a/rtemsspec/tests/test_interface.py b/rtemsspec/tests/test_interface.py index 3897d95f..e589d66f 100644 --- a/rtemsspec/tests/test_interface.py +++ b/rtemsspec/tests/test_interface.py @@ -86,12 +86,17 @@ def test_interface(tmpdir): */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html * - * for information how to maintain and re-generate this file. + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifndef _H_H diff --git a/rtemsspec/tests/test_specdoc.py b/rtemsspec/tests/test_specdoc.py index 8b4eccb4..105d765a 100644 --- a/rtemsspec/tests/test_specdoc.py +++ b/rtemsspec/tests/test_specdoc.py @@ -66,12 +66,17 @@ def test_document(tmpdir): .. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) -.. This file was automatically generated. Do not edit it manually. -.. Please have a look at +.. Do not manually edit this file. It is part of the RTEMS quality process +.. and was automatically generated. .. -.. https://docs.rtems.org/branches/master/eng/req/howto.html +.. If you find something that needs to be fixed or worded better please +.. post a report to an RTEMS mailing list or raise a bug report: +.. +.. https://docs.rtems.org/branches/master/user/support/bugs.html .. -.. for information how to maintain and re-generate this file. +.. For information on updating and regenerating please refer to: +.. +.. https://docs.rtems.org/branches/master/eng/req/howto.html .. _ReqEngSpecificationItems: diff --git a/rtemsspec/tests/test_validation.py b/rtemsspec/tests/test_validation.py index da735274..79eec641 100644 --- a/rtemsspec/tests/test_validation.py +++ b/rtemsspec/tests/test_validation.py @@ -78,12 +78,17 @@ def test_validation(tmpdir): */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html * - * for information how to maintain and re-generate this file. + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifdef HAVE_CONFIG_H @@ -150,12 +155,17 @@ def test_validation(tmpdir): */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html + * + * For information on updating and regenerating please refer to: * - * for information how to maintain and re-generate this file. + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifdef HAVE_CONFIG_H @@ -940,12 +950,17 @@ T_TEST_CASE_FIXTURE( Tc2, &test_case_2_fixture ) */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html + * + * For information on updating and regenerating please refer to: * - * for information how to maintain and re-generate this file. + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifdef HAVE_CONFIG_H @@ -1113,12 +1128,17 @@ void Tc6_Run( void ) */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html * - * for information how to maintain and re-generate this file. + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifndef _TC5_H @@ -1195,12 +1215,17 @@ void Tc5_Run( int *a, int b, int *c ); */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: + * + * https://docs.rtems.org/branches/master/user/support/bugs.html * - * for information how to maintain and re-generate this file. + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifndef _TC6_H @@ -1265,12 +1290,17 @@ void Tc6_Run( void ); */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: * - * for information how to maintain and re-generate this file. + * https://docs.rtems.org/branches/master/user/support/bugs.html + * + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifndef _ACTION2_H @@ -1372,12 +1402,17 @@ void Action2_Run( int *a, int b, int *c ); */ /* - * This file was automatically generated. Do not edit it manually. - * Please have a look at + * Do not manually edit this file. It is part of the RTEMS quality process + * and was automatically generated. * - * https://docs.rtems.org/branches/master/eng/req/howto.html + * If you find something that needs to be fixed or worded better please + * post a report to an RTEMS mailing list or raise a bug report: * - * for information how to maintain and re-generate this file. + * https://docs.rtems.org/branches/master/user/support/bugs.html + * + * For information on updating and regenerating please refer to: + * + * https://docs.rtems.org/branches/master/eng/req/howto.html */ #ifdef HAVE_CONFIG_H -- cgit v1.2.3