[rtems-central commit] spec: Place all interfaces in a header

[Sebastian Huber]

Module:    rtems-central
Branch:    master
Commit:    322caa7c6527028d7b3e3fa866ddd526e8455977
Changeset: http://git.rtems.org/rtems-central/commit/?id=322caa7c6527028d7b3e3fa866ddd526e8455977

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Sep 28 08:11:11 2020 +0200

spec: Place all interfaces in a header

---

 spec/rtems/io/if/getchark.yml |  4 +++-
 spec/rtems/io/if/header-2.yml | 12 ++++++++++++
 spec/rtems/io/if/header-3.yml | 12 ++++++++++++
 spec/rtems/io/if/header-4.yml | 13 +++++++++++++
 spec/rtems/io/if/mount.yml    |  4 +++-
 spec/rtems/io/if/printer.yml  |  4 +++-
 spec/rtems/io/if/printk.yml   |  4 +++-
 spec/rtems/io/if/putc.yml     |  6 ++++--
 spec/rtems/io/if/unmount.yml  |  4 +++-
 9 files changed, 56 insertions(+), 7 deletions(-)

diff --git a/spec/rtems/io/if/getchark.yml b/spec/rtems/io/if/getchark.yml
index 312942a..ac3f696 100644
--- a/spec/rtems/io/if/getchark.yml
+++ b/spec/rtems/io/if/getchark.yml
@@ -3,7 +3,9 @@ copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
 interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+  uid: header-3
 name: rtems_putc
 reference: null
 type: interface
diff --git a/spec/rtems/io/if/header-2.yml b/spec/rtems/io/if/header-2.yml
new file mode 100644
index 0000000..862551d
--- /dev/null
+++ b/spec/rtems/io/if/header-2.yml
@@ -0,0 +1,12 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the IO library API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+  uid: /if/domain
+path: rtems/libio.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/io/if/header-3.yml b/spec/rtems/io/if/header-3.yml
new file mode 100644
index 0000000..c4c8dcd
--- /dev/null
+++ b/spec/rtems/io/if/header-3.yml
@@ -0,0 +1,12 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the polled character IO driver API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+  uid: /if/domain
+path: rtems/bspIo.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/io/if/header-4.yml b/spec/rtems/io/if/header-4.yml
new file mode 100644
index 0000000..94e0c48
--- /dev/null
+++ b/spec/rtems/io/if/header-4.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This header file defines the kernel print API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+  uid: /if/domain
+path: rtems/print.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/io/if/mount.yml b/spec/rtems/io/if/mount.yml
index ee4d6ba..672bb91 100644
--- a/spec/rtems/io/if/mount.yml
+++ b/spec/rtems/io/if/mount.yml
@@ -3,7 +3,9 @@ copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
 interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+  uid: header-2
 name: mount
 reference: null
 type: interface
diff --git a/spec/rtems/io/if/printer.yml b/spec/rtems/io/if/printer.yml
index 118f068..1ec04cf 100644
--- a/spec/rtems/io/if/printer.yml
+++ b/spec/rtems/io/if/printer.yml
@@ -7,7 +7,9 @@ definition-kind: struct-only
 description: null
 enabled-by: true
 interface-type: struct
-links: []
+links:
+- role: interface-placement
+  uid: header-4
 name: rtems_printer
 notes: null
 type: interface
diff --git a/spec/rtems/io/if/printk.yml b/spec/rtems/io/if/printk.yml
index f8ed543..b5ca73f 100644
--- a/spec/rtems/io/if/printk.yml
+++ b/spec/rtems/io/if/printk.yml
@@ -3,7 +3,9 @@ copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
 interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+  uid: header-3
 name: printk
 reference: null
 type: interface
diff --git a/spec/rtems/io/if/putc.yml b/spec/rtems/io/if/putc.yml
index d49990b..ac3f696 100644
--- a/spec/rtems/io/if/putc.yml
+++ b/spec/rtems/io/if/putc.yml
@@ -3,7 +3,9 @@ copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
 interface-type: unspecified-function
-links: []
-name: getchark
+links:
+- role: interface-placement
+  uid: header-3
+name: rtems_putc
 reference: null
 type: interface
diff --git a/spec/rtems/io/if/unmount.yml b/spec/rtems/io/if/unmount.yml
index fa54890..53a5063 100644
--- a/spec/rtems/io/if/unmount.yml
+++ b/spec/rtems/io/if/unmount.yml
@@ -3,7 +3,9 @@ copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 enabled-by: true
 interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+  uid: header-2
 name: unmount
 reference: null
 type: interface