[rtems-central commit] content: Improve automatically generated warning
Sebastian Huber
sebh at rtems.org
Mon Jan 25 08:23:46 UTC 2021
Module: rtems-central
Branch: master
Commit: 4d5c6b987610d74c9ef61904776962fdda5bdb34
Changeset: http://git.rtems.org/rtems-central/commit/?id=4d5c6b987610d74c9ef61904776962fdda5bdb34
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Jan 19 06:56:43 2021 +0100
content: Improve automatically generated warning
---
rtemsspec/content.py | 10 ++++--
rtemsspec/tests/test_applconfig.py | 20 +++++++----
rtemsspec/tests/test_interface.py | 10 ++++--
rtemsspec/tests/test_interfacedoc.py | 40 ++++++++++++++-------
rtemsspec/tests/test_specdoc.py | 10 ++++--
rtemsspec/tests/test_validation.py | 70 +++++++++++++++++++++++++-----------
6 files changed, 112 insertions(+), 48 deletions(-)
diff --git a/rtemsspec/content.py b/rtemsspec/content.py
index c8e32af..cdd437a 100644
--- a/rtemsspec/content.py
+++ b/rtemsspec/content.py
@@ -164,11 +164,15 @@ _AUTOMATICALLY_GENERATED_WARNING = [
"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/rtemsspec/tests/test_applconfig.py b/rtemsspec/tests/test_applconfig.py
index 3da310c..c99e026 100644
--- a/rtemsspec/tests/test_applconfig.py
+++ b/rtemsspec/tests/test_applconfig.py
@@ -53,11 +53,15 @@ def test_applconfig(tmpdir):
.. 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:/g
@@ -436,11 +440,15 @@ NOTES:
* 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/rtemsspec/tests/test_interface.py b/rtemsspec/tests/test_interface.py
index 2ac2f3e..9cdea77 100644
--- a/rtemsspec/tests/test_interface.py
+++ b/rtemsspec/tests/test_interface.py
@@ -91,11 +91,15 @@ def test_interface(tmpdir):
* 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:/h */
diff --git a/rtemsspec/tests/test_interfacedoc.py b/rtemsspec/tests/test_interfacedoc.py
index c1c8f37..a99e279 100644
--- a/rtemsspec/tests/test_interfacedoc.py
+++ b/rtemsspec/tests/test_interfacedoc.py
@@ -61,11 +61,15 @@ def test_interfacedoc(tmpdir):
.. 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:/gb
@@ -109,11 +113,15 @@ The directives provided by the Group B are:
.. 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
.. _GroupBDirectives:
@@ -355,11 +363,15 @@ Macro without parameters.
.. 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:/ga
@@ -389,11 +401,15 @@ Group A description. The directives provided by the Group A are:
.. 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
.. _GroupADirectives:
diff --git a/rtemsspec/tests/test_specdoc.py b/rtemsspec/tests/test_specdoc.py
index 192c714..df875a2 100644
--- a/rtemsspec/tests/test_specdoc.py
+++ b/rtemsspec/tests/test_specdoc.py
@@ -71,11 +71,15 @@ def test_document(tmpdir):
.. 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
.. _ReqEngSpecificationItems:
diff --git a/rtemsspec/tests/test_validation.py b/rtemsspec/tests/test_validation.py
index 77ed8eb..2dd1ab7 100644
--- a/rtemsspec/tests/test_validation.py
+++ b/rtemsspec/tests/test_validation.py
@@ -83,11 +83,15 @@ def test_validation(tmpdir):
* 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
@@ -159,11 +163,15 @@ def test_validation(tmpdir):
* 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
@@ -954,11 +962,15 @@ T_TEST_CASE_FIXTURE( Tc2, &test_case_2_fixture )
* 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
@@ -1326,11 +1338,15 @@ void Tc6_Run( void )
* 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
*/
#ifndef _TC5_H
@@ -1412,11 +1428,15 @@ void Tc5_Run( int *a, int b, int *c );
* 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
*/
#ifndef _TC6_H
@@ -1486,11 +1506,15 @@ void Tc6_Run( void );
* 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
*/
#ifndef _ACTION2_H
@@ -1597,11 +1621,15 @@ void Action2_Run( int *a, int b, int *c );
* 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 vc
mailing list