From 168127b60ac314c7226bb7e8bee758cb7911de59 Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@free.fr>
Date: Mon, 27 Apr 2015 17:43:51 +0200
Subject: [PATCH] dib-lint: test elements have README.rst file

Add a basic test to ensure that all elements have a README.rst file.
This way they will be exhaustively listed in the Sphinx documentation.

Add dummy README.rst for 'disable-selinux' and 'rpm-distro' elements.

Change-Id: Ia5252ddd89b5ae5c6e9a12a66ef10f912fd54da5
---
 bin/dib-lint                                          | 5 +++++
 diskimage_builder/elements/disable-selinux/README.rst | 4 ++++
 diskimage_builder/elements/rpm-distro/README.rst      | 4 ++++
 3 files changed, 13 insertions(+)
 create mode 100644 diskimage_builder/elements/disable-selinux/README.rst
 create mode 100644 diskimage_builder/elements/rpm-distro/README.rst

diff --git a/bin/dib-lint b/bin/dib-lint
index e1e3c82d1..5cdeb0c2a 100755
--- a/bin/dib-lint
+++ b/bin/dib-lint
@@ -71,6 +71,11 @@ rc=0
 TMPDIR=$(mktemp -d /tmp/tmp.XXXXXXXXXX)
 trap "rm -rf $TMPDIR" EXIT
 
+# Elements have a README.rst file
+for i in $(find $ELEMENTS_DIR -mindepth 1 -maxdepth 1 -type d); do
+    [ -f "${i}/README.rst" ] || error "$i lacks a README.rst"
+done
+
 # note .py files are run through flake8 directly in tox.ini
 for i in $(find $ELEMENTS_DIR -type f \
                 -not -name \*.rst     \
diff --git a/diskimage_builder/elements/disable-selinux/README.rst b/diskimage_builder/elements/disable-selinux/README.rst
new file mode 100644
index 000000000..3aba55317
--- /dev/null
+++ b/diskimage_builder/elements/disable-selinux/README.rst
@@ -0,0 +1,4 @@
+disable-selinux
+---------------
+
+Including this element disables SELinux.
diff --git a/diskimage_builder/elements/rpm-distro/README.rst b/diskimage_builder/elements/rpm-distro/README.rst
new file mode 100644
index 000000000..cce5b8cac
--- /dev/null
+++ b/diskimage_builder/elements/rpm-distro/README.rst
@@ -0,0 +1,4 @@
+rpm-distro
+----------
+
+Base element for distributions based on RPM.