Documentation is not built for some versions.

4 files changed, 156 insertions, 62 deletions

diff --git a/README-doc.txt.in b/README-doc.txt.in
new file mode 100644
index 0000000..7e795e8
--- /dev/null
+++ b/README-doc.txt.in
@@ -0,0 +1,104 @@
+RTEMS Embedded Realtime Operating System
+----------------------------------------
+
+Release: @RELEASE@
+Date   : @DATE@
+
+The Real-Time Executive for Multiprocessor Systems or RTEMS is an open source
+Real Time Operating System (RTOS) that supports open standard application
+programming interfaces (API) such as POSIX. It is used in space flight,
+medical, networking and many more embedded devices using processor
+architectures including ARM, PowerPC, Intel, Blackfin, MIPS, Microblaze and
+more.
+
+This directory contains the source code for the RTEMS @VERSION@ operating
+system and tools. Please refer to the RTEMS Developers Wiki for the release
+notes.
+
+Please drop by the Users mailing list (users@rtems.org) and let us know how you
+are using RTEMS. We love hearing about user's projects.
+
+Many thanks to everyone who helped create this release.
+
+Regards
+The RTEMS Development Team.
+
+RTEMS Web Sites
+~~~~~~~~~~~~~~~
+
+      Home: https://www.rtems.org/
+Developers: https://devel.rtems.org/
+      Docs: https://docs.rtems.org/
+       Bug: https://devel.rtems.org/query
+     Lists: https://lists.rtems.org/
+       GIT: https://git.rtems.org/
+
+Release Files
+~~~~~~~~~~~~~
+
+ - README.txt					This document.
+ - contrib			     		Directory contains extra release related files.
+ - rtems-@RELEASE@.tar.xz  		    	The RTEMS kernel source code.
+ - rtems-source-builder-@RELEASE@.tar.xz	The RTEMS Source Builder source code.
+ - rtems-tools-@RELEASE@.tar.xz		The RTEMS Tools source code.
+ - rtems-docs-@RELEASE@.tar.xz		The RTEMS Documentation source.
+ - sha512sum.txt				The SHA512 checksums for this directory.
+ - docs						The generated RTEMS documentation.
+ - sources					The source code the tools for this release.
+
+RTEMS Documentation
+~~~~~~~~~~~~~~~~~~~
+
+The generated documentation can be found in the `docs` directory.
+
+The following manuals are available as compress HTML tar files or PDF:
+
+ - RTEMS User Manual
+  - docs/rtems-docs-@RELEASE@-user.pdf
+  - docs/rtems-docs-@RELEASE@-user-html.tar.xz
+
+ - RTEMS C User Manual
+  - docs/rtems-docs-@RELEASE@-c-user.pdf
+  - docs/rtems-docs-@RELEASE@-c-user-html.tar.xz
+
+ - RTEMS POSIX User Manual
+  - docs/rtems-docs-@RELEASE@-posix-user.pdf
+  - docs/rtems-docs-@RELEASE@-posix-user-html.tar.xz
+
+ - RTEMS Networking User Manual
+  - docs/rtems-docs-@RELEASE@-networking.pdf
+  - docs/rtems-docs-@RELEASE@-networking-html.tar.xz
+
+ - RTEMS Shell User Manual
+  - docs/rtems-docs-@RELEASE@-shell.pdf
+  - docs/rtems-docs-@RELEASE@-shell-html.tar.xz
+
+Quick Guide to Building
+~~~~~~~~~~~~~~~~~~~~~~~
+
+To build the tools and kernel for an architecture download:
+
+  rtems-source-builder-@RELEASE@.tar.xz
+
+Please check to the RSB documentation (https://docs.rtems.org/rsb/) and the
+Wiki (TBD) if you have any issues.
+
+If you encounter a problem please post to the user@rtems.org mailing list and
+if you find a bug please raise a ticket (https://devel.rtems.org/newticket).
+
+The following builds RTEMS for the SPARC architecture:
+
+ $ cd
+ $ mkdir development/rtems
+ $ cd development/rtems
+ $ tar Jxf rtems-source-builder-@RELEASE@.tar.xz
+ $ cd rtems-source-builder-@RELEASE@/rtems
+ $ ../source-builder/sb-set-builder \
+         --prefix=$HOME/development/rtems/@RELEASE@ \
+	 @VERSION@/rtems-sparc
+
+To disable building the RTEMS Kernel add to the command line '--without-rtems'.
+
+To build a single BSP add to the command line '--with-rtemsbsp'. You can
+specify more than one BSP with quotes and a space delimiting the BSP names. By
+default all BSPs for an architecture are built.
diff --git a/README.txt.in b/README.txt.in
index 1fcf3e2..4ef0642 100644
--- a/README.txt.in
+++ b/README.txt.in
@@ -41,42 +41,13 @@ Release Files
  - rtems-@RELEASE@.tar.xz  		    	The RTEMS kernel source code.
  - rtems-source-builder-@RELEASE@.tar.xz	The RTEMS Source Builder source code.
  - rtems-tools-@RELEASE@.tar.xz		The RTEMS Tools source code.
- - rtems-docs-@RELEASE@.tar.xz		The RTEMS Documentation source.
  - sha512sum.txt				The SHA512 checksums for this directory.
- - docs						The generated RTEMS documentation.
  - sources					The source code the tools for this release.
 
-RTEMS Documentation
-~~~~~~~~~~~~~~~~~~~
-
-The generated documentation can be found in the `docs` directory.
-
-The following manuals are available as compress HTML tar files or PDF:
-
- - RTEMS User Manual
-  - docs/rtems-docs-@RELEASE@-user.pdf
-  - docs/rtems-docs-@RELEASE@-user-html.tar.xz
-
- - RTEMS C User Manual
-  - docs/rtems-docs-@RELEASE@-c-user.pdf
-  - docs/rtems-docs-@RELEASE@-c-user-html.tar.xz
-
- - RTEMS POSIX User Manual
-  - docs/rtems-docs-@RELEASE@-posix-user.pdf
-  - docs/rtems-docs-@RELEASE@-posix-user-html.tar.xz
-
- - RTEMS Networking User Manual
-  - docs/rtems-docs-@RELEASE@-networking.pdf
-  - docs/rtems-docs-@RELEASE@-networking-html.tar.xz
-
- - RTEMS Shell User Manual
-  - docs/rtems-docs-@RELEASE@-shell.pdf
-  - docs/rtems-docs-@RELEASE@-shell-html.tar.xz
-
 Quick Guide to Building
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-To build the tools and kernel for an archicture download:
+To build the tools and kernel for an architecture download:
 
   rtems-source-builder-@RELEASE@.tar.xz
 
@@ -97,7 +68,7 @@ The following builds RTEMS for the SPARC architecture:
          --prefix=$HOME/development/rtems/@RELEASE@ \
 	 @VERSION@/rtems-sparc
 
-To not build the RTEMS Kernel add to the command line '--without-rtems'.
+To disable building the RTEMS Kernel add to the command line '--without-rtems'.
 
 To build a single BSP add to the command line '--with-rtemsbsp'. You can
 specify more than one BSP with quotes and a space delimiting the BSP names. By
diff --git a/rtems-release b/rtems-release
index 00c164c..f8e8876 100755
--- a/rtems-release
+++ b/rtems-release
@@ -47,36 +47,6 @@ set -e
 top=${PWD}
 
 #
-# Defaults.
-#
-rtems_doc=yes
-
-#
-# Check for options
-#
-opts=yes
-while [ $opts = yes ];
-do
- case $1 in
-  -*)
-   case $1 in
-    --no-docs)
-     rtems_docs=no
-     ;;
-    *)
-     echo "error: invalid option: $1"
-     exit 1
-     ;;
-   esac
-   shift
-   ;;
-  *)
-   opts=no
-   ;;
- esac
-done
-
-#
 # The version and revision.
 #
 if [ $# -ne 2 ]; then
@@ -90,6 +60,19 @@ release=${version}.${revision}
 
 checksum=sha512
 
+#
+# Defaults.
+#
+rtems_doc=yes
+rtems_readme=README.txt.in
+
+#
+# Version default settings.
+#
+if [ -f rtems-release-defaults-${version} ]; then
+ . rtems-release-defaults-${version}
+fi
+
 build()
 {
  echo "Package: $1"
@@ -116,6 +99,7 @@ build rtems-source-builder ${version} ${revision} rtems-release-rsb-hashing
 #
 if [ ${rtems_docs} = yes ]; then
  ./rtems-release-docs rtems-docs ${version} ${revision}
+ rtems_readme=README-doc.txt.in
 fi
 
 #
@@ -128,7 +112,7 @@ echo "Collect tools sources"
 # Create the README.txt
 #
 now=$(date +"%d %B %Y")
-cat README.txt.in | \
+cat ${rtems_readme} | \
     sed -e "s/@RELEASE@/${release}/g" \
 	-e "s/@VERSION@/${version}/g" \
 	-e "s/@REVISION@/${revision}/g" \
diff --git a/rtems-release-defaults-4.10 b/rtems-release-defaults-4.10
new file mode 100755
index 0000000..c3a9ccc
--- /dev/null
+++ b/rtems-release-defaults-4.10
@@ -0,0 +1,35 @@
+#! /bin/sh
+#
+# RTEMS Tools Project (http://www.rtems.org/)
+# Copyright 2015-2016 Chris Johns (chrisj@rtems.org)
+# All rights reserved.
+#
+# This file is part of the RTEMS Tools package in 'rtems-tools'.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+
+#
+# The script is the defaults for 4.10.
+#
+rtems_doc=no