[rtems-docs commit] Improve file header comment in generated files
Sebastian Huber
sebh at rtems.org
Mon Jan 25 05:58:33 UTC 2021
Module: rtems-docs
Branch: master
Commit: ba633eca2d27ce473f1510ee3fb6831b1a992f2f
Changeset: http://git.rtems.org/rtems-docs/commit/?id=ba633eca2d27ce473f1510ee3fb6831b1a992f2f
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Mon Jan 25 06:58:10 2021 +0100
Improve file header comment in generated files
---
c-user/config/bdbuf.rst | 10 +++++++---
c-user/config/bsp-related.rst | 10 +++++++---
c-user/config/classic-api.rst | 10 +++++++---
c-user/config/classic-init-task.rst | 10 +++++++---
c-user/config/device-driver.rst | 10 +++++++---
c-user/config/event-record.rst | 10 +++++++---
c-user/config/filesystem.rst | 10 +++++++---
c-user/config/general.rst | 10 +++++++---
c-user/config/idle-task.rst | 10 +++++++---
c-user/config/mpci.rst | 10 +++++++---
c-user/config/posix-api.rst | 10 +++++++---
c-user/config/posix-init-thread.rst | 10 +++++++---
c-user/config/scheduler-general.rst | 10 +++++++---
c-user/config/task-stack-alloc.rst | 10 +++++++---
c-user/event/directives.rst | 10 +++++++---
c-user/event/introduction.rst | 10 +++++++---
c-user/io/directives.rst | 10 +++++++---
c-user/io/introduction.rst | 10 +++++++---
c-user/object-services/directives.rst | 10 +++++++---
c-user/object-services/introduction.rst | 10 +++++++---
c-user/partition/directives.rst | 10 +++++++---
c-user/partition/introduction.rst | 10 +++++++---
c-user/timer/directives.rst | 10 +++++++---
c-user/timer/introduction.rst | 10 +++++++---
eng/req/items.rst | 10 +++++++---
25 files changed, 175 insertions(+), 75 deletions(-)
diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 06399e0..7377bee 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -8,11 +8,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:/acfg/if/group-bdbuf
diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst
index 3d0a3ca..e56cee4 100644
--- a/c-user/config/bsp-related.rst
+++ b/c-user/config/bsp-related.rst
@@ -8,11 +8,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:/acfg/if/group-bsp
diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst
index e44716a..29dafc0 100644
--- a/c-user/config/classic-api.rst
+++ b/c-user/config/classic-api.rst
@@ -8,11 +8,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:/acfg/if/group-classic
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst
index b331e40..0743929 100644
--- a/c-user/config/classic-init-task.rst
+++ b/c-user/config/classic-init-task.rst
@@ -8,11 +8,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:/acfg/if/group-classicinit
diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
index 4fd8c71..05ae08a 100644
--- a/c-user/config/device-driver.rst
+++ b/c-user/config/device-driver.rst
@@ -8,11 +8,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:/acfg/if/group-devdrv
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
index 48de243..cbe02e3 100644
--- a/c-user/config/event-record.rst
+++ b/c-user/config/event-record.rst
@@ -7,11 +7,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:/acfg/if/group-eventrecord
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 1daea01..5b1b414 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -8,11 +8,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:/acfg/if/group-filesystem
diff --git a/c-user/config/general.rst b/c-user/config/general.rst
index c2cb349..024b5c4 100644
--- a/c-user/config/general.rst
+++ b/c-user/config/general.rst
@@ -8,11 +8,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:/acfg/if/group-general
diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst
index f115dae..9330672 100644
--- a/c-user/config/idle-task.rst
+++ b/c-user/config/idle-task.rst
@@ -8,11 +8,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:/acfg/if/group-idle
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
index e0fbe1d..0c967c6 100644
--- a/c-user/config/mpci.rst
+++ b/c-user/config/mpci.rst
@@ -8,11 +8,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:/acfg/if/group-mpci
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
index aa44467..592a1ce 100644
--- a/c-user/config/posix-api.rst
+++ b/c-user/config/posix-api.rst
@@ -8,11 +8,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:/acfg/if/group-posix
diff --git a/c-user/config/posix-init-thread.rst b/c-user/config/posix-init-thread.rst
index 4c49bdd..42542e5 100644
--- a/c-user/config/posix-init-thread.rst
+++ b/c-user/config/posix-init-thread.rst
@@ -8,11 +8,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:/acfg/if/group-posixinit
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index 5478e84..7bdd044 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -9,11 +9,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:/acfg/if/group-schedgeneral
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 733ffd3..cd174ed 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -8,11 +8,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:/acfg/if/group-stackalloc
diff --git a/c-user/event/directives.rst b/c-user/event/directives.rst
index ee43e0b..1a37313 100644
--- a/c-user/event/directives.rst
+++ b/c-user/event/directives.rst
@@ -8,11 +8,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
.. _EventManagerDirectives:
diff --git a/c-user/event/introduction.rst b/c-user/event/introduction.rst
index a153cf3..69a2e7e 100644
--- a/c-user/event/introduction.rst
+++ b/c-user/event/introduction.rst
@@ -8,11 +8,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/group
diff --git a/c-user/io/directives.rst b/c-user/io/directives.rst
index c0a50d4..a6cd755 100644
--- a/c-user/io/directives.rst
+++ b/c-user/io/directives.rst
@@ -8,11 +8,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
.. _IOManagerDirectives:
diff --git a/c-user/io/introduction.rst b/c-user/io/introduction.rst
index 706c711..7d2c35d 100644
--- a/c-user/io/introduction.rst
+++ b/c-user/io/introduction.rst
@@ -8,11 +8,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/group
diff --git a/c-user/object-services/directives.rst b/c-user/object-services/directives.rst
index ce7a894..75a0516 100644
--- a/c-user/object-services/directives.rst
+++ b/c-user/object-services/directives.rst
@@ -8,11 +8,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
.. _ObjectServicesDirectives:
diff --git a/c-user/object-services/introduction.rst b/c-user/object-services/introduction.rst
index 6e7f4af..6d02c9a 100644
--- a/c-user/object-services/introduction.rst
+++ b/c-user/object-services/introduction.rst
@@ -8,11 +8,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/group
diff --git a/c-user/partition/directives.rst b/c-user/partition/directives.rst
index e28ef2e..ae3e921 100644
--- a/c-user/partition/directives.rst
+++ b/c-user/partition/directives.rst
@@ -8,11 +8,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
.. _PartitionManagerDirectives:
diff --git a/c-user/partition/introduction.rst b/c-user/partition/introduction.rst
index 02ccf28..8cc33e1 100644
--- a/c-user/partition/introduction.rst
+++ b/c-user/partition/introduction.rst
@@ -8,11 +8,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/group
diff --git a/c-user/timer/directives.rst b/c-user/timer/directives.rst
index d65f263..a4d1b64 100644
--- a/c-user/timer/directives.rst
+++ b/c-user/timer/directives.rst
@@ -8,11 +8,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
.. _TimerManagerDirectives:
diff --git a/c-user/timer/introduction.rst b/c-user/timer/introduction.rst
index 78f6c67..6806898 100644
--- a/c-user/timer/introduction.rst
+++ b/c-user/timer/introduction.rst
@@ -8,11 +8,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/group
diff --git a/eng/req/items.rst b/eng/req/items.rst
index c160ee7..418d27e 100644
--- a/eng/req/items.rst
+++ b/eng/req/items.rst
@@ -7,11 +7,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
.. _ReqEngSpecificationItems:
More information about the vc
mailing list