[rtems-docs commit] Improve file header comment in generated files
Sebastian Huber
sebh at rtems.org
Sun Oct 11 13:20:39 UTC 2020
Module: rtems-docs
Branch: master
Commit: dd97e25fafadca0c02779a3b2dd5db61f17dd915
Changeset: http://git.rtems.org/rtems-docs/commit/?id=dd97e25fafadca0c02779a3b2dd5db61f17dd915
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Sun Oct 11 15:17:39 2020 +0200
Improve file header comment in generated files
---
c-user/config/bdbuf.rst | 13 +++++++++----
c-user/config/bsp-related.rst | 13 +++++++++----
c-user/config/classic-api.rst | 13 +++++++++----
c-user/config/classic-init-task.rst | 13 +++++++++----
c-user/config/device-driver.rst | 13 +++++++++----
c-user/config/event-record.rst | 13 +++++++++----
c-user/config/filesystem.rst | 13 +++++++++----
c-user/config/general.rst | 13 +++++++++----
c-user/config/idle-task.rst | 13 +++++++++----
c-user/config/mpci.rst | 13 +++++++++----
c-user/config/posix-api.rst | 13 +++++++++----
c-user/config/posix-init-thread.rst | 13 +++++++++----
c-user/config/scheduler-general.rst | 13 +++++++++----
c-user/config/task-stack-alloc.rst | 13 +++++++++----
eng/req/items.rst | 13 +++++++++----
15 files changed, 135 insertions(+), 60 deletions(-)
diff --git a/c-user/config/bdbuf.rst b/c-user/config/bdbuf.rst
index 8f49c89..1a0d393 100644
--- a/c-user/config/bdbuf.rst
+++ b/c-user/config/bdbuf.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Block Device Cache Configuration
================================
diff --git a/c-user/config/bsp-related.rst b/c-user/config/bsp-related.rst
index f50fb23..8ed34cf 100644
--- a/c-user/config/bsp-related.rst
+++ b/c-user/config/bsp-related.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
BSP Related Configuration Options
=================================
diff --git a/c-user/config/classic-api.rst b/c-user/config/classic-api.rst
index bc6bfab..d1e197b 100644
--- a/c-user/config/classic-api.rst
+++ b/c-user/config/classic-api.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Classic API Configuration
=========================
diff --git a/c-user/config/classic-init-task.rst b/c-user/config/classic-init-task.rst
index e148ddd..8430757 100644
--- a/c-user/config/classic-init-task.rst
+++ b/c-user/config/classic-init-task.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Classic API Initialization Task Configuration
=============================================
diff --git a/c-user/config/device-driver.rst b/c-user/config/device-driver.rst
index f23e8a3..25f15d1 100644
--- a/c-user/config/device-driver.rst
+++ b/c-user/config/device-driver.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Device Driver Configuration
===========================
diff --git a/c-user/config/event-record.rst b/c-user/config/event-record.rst
index 7e62eaf..462f9e2 100644
--- a/c-user/config/event-record.rst
+++ b/c-user/config/event-record.rst
@@ -2,12 +2,17 @@
.. Copyright (C) 2019, 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
Event Recording Configuration
=============================
diff --git a/c-user/config/filesystem.rst b/c-user/config/filesystem.rst
index 6a5e23a..9269236 100644
--- a/c-user/config/filesystem.rst
+++ b/c-user/config/filesystem.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Filesystem Configuration
========================
diff --git a/c-user/config/general.rst b/c-user/config/general.rst
index 3073239..b78a81c 100644
--- a/c-user/config/general.rst
+++ b/c-user/config/general.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
General System Configuration
============================
diff --git a/c-user/config/idle-task.rst b/c-user/config/idle-task.rst
index 1d734d8..8210da1 100644
--- a/c-user/config/idle-task.rst
+++ b/c-user/config/idle-task.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Idle Task Configuration
=======================
diff --git a/c-user/config/mpci.rst b/c-user/config/mpci.rst
index 1df8b52..aa35b1e 100644
--- a/c-user/config/mpci.rst
+++ b/c-user/config/mpci.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Multiprocessing Configuration
=============================
diff --git a/c-user/config/posix-api.rst b/c-user/config/posix-api.rst
index 2a64c46..6e91205 100644
--- a/c-user/config/posix-api.rst
+++ b/c-user/config/posix-api.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
POSIX API Configuration
=======================
diff --git a/c-user/config/posix-init-thread.rst b/c-user/config/posix-init-thread.rst
index 6d5a25a..deadbc6 100644
--- a/c-user/config/posix-init-thread.rst
+++ b/c-user/config/posix-init-thread.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
POSIX Initialization Thread Configuration
=========================================
diff --git a/c-user/config/scheduler-general.rst b/c-user/config/scheduler-general.rst
index 72fa0e2..8c60a96 100644
--- a/c-user/config/scheduler-general.rst
+++ b/c-user/config/scheduler-general.rst
@@ -4,12 +4,17 @@
.. Copyright (C) 2010 Gedare Bloom
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
General Scheduler Configuration
===============================
diff --git a/c-user/config/task-stack-alloc.rst b/c-user/config/task-stack-alloc.rst
index 9c86b33..a567477 100644
--- a/c-user/config/task-stack-alloc.rst
+++ b/c-user/config/task-stack-alloc.rst
@@ -3,12 +3,17 @@
.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
-.. 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
Task Stack Allocator Configuration
==================================
diff --git a/eng/req/items.rst b/eng/req/items.rst
index 3d1ef2a..0d5317a 100644
--- a/eng/req/items.rst
+++ b/eng/req/items.rst
@@ -2,12 +2,17 @@
.. Copyright (C) 2019, 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:
More information about the vc
mailing list