From cc308464c624a0a68d1ed312903b4871c4b3b6fc Mon Sep 17 00:00:00 2001 From: Gregory Haynes Date: Thu, 2 Apr 2015 04:21:50 +0000 Subject: [PATCH] No markdown docs for elements Sphinx does not support markdown, therefore all our element docs should not be in this format. Change-Id: I6fceb5c2c218e94a463f13d6d9050aea485e6c31 --- bin/dib-lint | 7 ++++++- elements/deploy-targetcli/{README.md => README.rst} | 3 +++ elements/deploy-tgtadm/{README.md => README.rst} | 3 +++ 3 files changed, 12 insertions(+), 1 deletion(-) rename elements/deploy-targetcli/{README.md => README.rst} (87%) rename elements/deploy-tgtadm/{README.md => README.rst} (88%) diff --git a/bin/dib-lint b/bin/dib-lint index 8ecfb760..23949f59 100755 --- a/bin/dib-lint +++ b/bin/dib-lint @@ -128,7 +128,7 @@ for i in $(find elements -type f); do fi done -for i in $(find elements -type f -and -name '*.md' -or -type f -executable); do +for i in $(find elements -type f -and -name '*.rst' -or -type f -executable); do # Check for tab indentation if ! excluded tabindent; then if grep -q $'^ *\t' ${i}; then @@ -142,4 +142,9 @@ for i in $(find elements -type f -and -name '*.md' -or -type f -executable); do fi fi done + +md_docs=$(find elements -name '*.md') +if [ -n "$md_docs" ]; then + error ".md docs found: $md_docs" +fi exit $rc diff --git a/elements/deploy-targetcli/README.md b/elements/deploy-targetcli/README.rst similarity index 87% rename from elements/deploy-targetcli/README.md rename to elements/deploy-targetcli/README.rst index b79d6e86..00a522c8 100644 --- a/elements/deploy-targetcli/README.md +++ b/elements/deploy-targetcli/README.rst @@ -1,3 +1,6 @@ +deploy-targetcli +================ + Use targetcli for the deploy ramdisk Provides the necessary scripts and dependencies to use targetcli diff --git a/elements/deploy-tgtadm/README.md b/elements/deploy-tgtadm/README.rst similarity index 88% rename from elements/deploy-tgtadm/README.md rename to elements/deploy-tgtadm/README.rst index b09487cd..466be8fd 100644 --- a/elements/deploy-tgtadm/README.md +++ b/elements/deploy-tgtadm/README.rst @@ -1,3 +1,6 @@ +deploy-tgtadm +============= + Use tgtadm and tgtd for the deploy ramdisk Provides the necessary scripts and dependencies to use tgtadm