Fix the doco and packaging of docs. Sort out the README.txt templates.

7 files changed, 170 insertions, 159 deletions

diff --git a/README-doc.txt.in b/README-4.10.txt.in
index 1311f46..3c8d478 100644
--- a/README-doc.txt.in
+++ b/README-4.10.txt.in
@@ -4,12 +4,12 @@ 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, SPARC, Intel, Blackfin,
-MIPS, Microblaze and more.
+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
@@ -40,39 +40,10 @@ Release Files
  - 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.
+ - rtems-tools-@RELEASE@.tar.xz		The RTEMS Tools source code.
  - 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
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -95,7 +66,7 @@ The following builds RTEMS for the SPARC architecture:
  $ cd rtems-source-builder-@RELEASE@/rtems
  $ ../source-builder/sb-set-builder \
          --prefix=$HOME/development/rtems/@RELEASE@ \
-         @VERSION@/rtems-sparc
+	 @VERSION@/rtems-sparc
 
 To disable building the RTEMS Kernel add to the command line '--without-rtems'.
 
diff --git a/README.txt.in b/README.txt.in
index 4ef0642..7a79724 100644
--- a/README.txt.in
+++ b/README.txt.in
@@ -4,12 +4,12 @@ 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.
+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, SPARC, 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
@@ -40,10 +40,39 @@ Release Files
  - 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-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
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -66,7 +95,7 @@ The following builds RTEMS for the SPARC architecture:
  $ cd rtems-source-builder-@RELEASE@/rtems
  $ ../source-builder/sb-set-builder \
          --prefix=$HOME/development/rtems/@RELEASE@ \
-	 @VERSION@/rtems-sparc
+         @VERSION@/rtems-sparc
 
 To disable building the RTEMS Kernel add to the command line '--without-rtems'.
 
diff --git a/rtems-release b/rtems-release
index ac32b24..230cb8a 100755
--- a/rtems-release
+++ b/rtems-release
@@ -95,11 +95,10 @@ build rtems                ${version} ${revision} rtems-release-kernel
 build rtems-source-builder ${version} ${revision} rtems-release-rsb-hashing
 
 #
-# Documentation currently uses a custom packaging script. It needs a branch.
+# Documentation.
 #
 if [ ${rtems_docs} = yes ]; then
  ./rtems-release-docs rtems-docs ${version} ${revision}
- rtems_readme=README-doc.txt.in
 fi
 
 #
@@ -128,10 +127,18 @@ rm ARCH-BSP.txt
 # Copy these release scripts to a contrib directory.
 #
 mkdir -p ${release}/contrib/releasing
-for f in README.txt README.txt.in \
-         rtems-release rtems-release-kernel \
-         rtems-release-package rtems-release-rsb-hashing \
-         rtems-release-sources
+for f in README.txt \
+	 README.txt.in \
+         rtems-release \
+	 rtems-release-defaults-4.10 \
+	 rtems-release-docs \
+	 rtems-release-kernel \
+         rtems-release-package \
+         rtems-release-package-end \
+         rtems-release-package-start \
+	 rtems-release-rsb-hashing \
+         rtems-release-sources \
+	 rtems-source-packages
 do
  cp ${f} ${release}/contrib/releasing/
  csum=$(${checksum} -q ${f})
diff --git a/rtems-release-defaults-4.10 b/rtems-release-defaults-4.10
index 12a13f6..91dba75 100755
--- a/rtems-release-defaults-4.10
+++ b/rtems-release-defaults-4.10
@@ -33,3 +33,4 @@
 # The script is the defaults for 4.10.
 #
 rtems_docs=no
+rtems_readme=README-4.10.txt.in
diff --git a/rtems-release-docs b/rtems-release-docs
index 5a0afb1..383d8b7 100755
--- a/rtems-release-docs
+++ b/rtems-release-docs
@@ -64,8 +64,10 @@ echo "git clone ${git_remote} ${git_local}"
 git clone ${git_remote} ${git_local}
 
 cd ${git_local}
- echo "git archive --format=tar --prefix=${prefix}/ origin/master"
- git archive --format=tar --prefix=${prefix}/ origin/master | \
+ echo "git fetch origin"
+ git fetch origin
+ echo "git archive --format=tar --prefix=${prefix}/ origin/${version}"
+ git archive --format=tar --prefix=${prefix}/ origin/${version} | \
      xz > ../${prefix}-unstamped.tar.xz
  cd ..
 
diff --git a/rtems-release-package b/rtems-release-package
index 6758270..02f5d7e 100755
--- a/rtems-release-package
+++ b/rtems-release-package
@@ -53,12 +53,12 @@ git clone ${git_remote} ${git_local}
 stamped_tar=${prefix}-unstamped.tar.xz
 
 cd ${git_local}
-echo "git fetch origin"
-git fetch origin
-echo "git archive --format=tar --prefix=${prefix}/ origin/${version}"
-git archive --format=tar --prefix=${prefix}/ origin/${version} | \
-    xz > ../${stamped_tar}
-cd ..
+ echo "git fetch origin"
+ git fetch origin
+ echo "git archive --format=tar --prefix=${prefix}/ origin/${version}"
+ git archive --format=tar --prefix=${prefix}/ origin/${version} | \
+     xz > ../${stamped_tar}
+ cd ..
 
 if [ ! -f ${stamped_tar} ]; then
  echo "error: git archive failed, no tar file"
@@ -68,10 +68,10 @@ echo "tar Jxf ${stamped_tar}"
 tar Jxf ${stamped_tar}
 
 cd ${prefix}
-echo "Creating VERSION: ${release}"
-echo "[version]" > VERSION
-echo "release = ${release}" >> VERSION
-cd ..
+ echo "Creating VERSION: ${release}"
+ echo "[version]" > VERSION
+ echo "release = ${release}" >> VERSION
+ cd ..
 
 #
 # Run the worker script if provided. It can perform any package
diff --git a/rtems-release-sources b/rtems-release-sources
index 741a2a9..55a8ee5 100755
--- a/rtems-release-sources
+++ b/rtems-release-sources
@@ -89,118 +89,119 @@ cd ${release}
  mkdir ${workspace}
  cd ${workspace}
 
- echo "tar Jxf ../${prefix}.tar.xz"
- tar Jxf ../${prefix}.tar.xz
-
- #
- # Get the RSB to download the source we need to release. This is 100% of the
- # actual sourced used.
- #
- cd ${prefix}
-  cd rtems
-   export_source=rtems
-   mkdir sources patches
-   #
-   # Copy in any source not present on the server. If these are not copied in
-   # the RSB does not find them.
-   #
-   for p in rtems-tools rtems
-   do
-    cp ${top}/${release}/${p}-${release}.tar.xz sources/
-   done
-   #
-   # Fetch the source for RTEMS tools.
-   #
-   echo "../source-builder/sb-set-builder --dry-run --with-download " \
-        "--without-error-report --without-release-url " \
-        "${rtems_pkgs}"
-   ../source-builder/sb-set-builder --dry-run --with-download \
-                                    --without-error-report \
-                                    --without-release-url \
-                                    ${rtems_pkgs}
-
-   # If git, svn or cvs exist the release fails.
-   #
-   if [ -d sources/git -o -d sources/svn -o -d sources/cvs ]; then
-    echo "error: ${release} contains repositories and cannot be released."
-    exit 1
-   fi
-   #
-  # Clean out the packages we do not places in 'sources' we copied in..
-  #
-  for p in rtems-tools rtems
-  do
-   rm sources/${p}-${release}.tar.xz
-  done
-  cd ..
+  echo "tar Jxf ../${prefix}.tar.xz"
+  tar Jxf ../${prefix}.tar.xz
+
   #
-  # Fetch the source for 3rd party packages tools.
+  # Get the RSB to download the source we need to release. This is 100% of the
+  # actual sourced used.
   #
-  if [ -n "${bare_pkgs}" -a "${bare_pkgs}" != "None" ]; then
-   cd bare
-    export_source="${export_source} bare"
+  cd ${prefix}
+   cd rtems
+    export_source=rtems
     mkdir sources patches
+    #
+    # Copy in any source not present on the server. If these are not copied in
+    # the RSB does not find them.
+    #
+    for p in rtems-tools rtems
+    do
+     cp ${top}/${release}/${p}-${release}.tar.xz sources/
+    done
+    #
+    # Fetch the source for RTEMS tools.
+    #
     echo "../source-builder/sb-set-builder --dry-run --with-download " \
          "--without-error-report --without-release-url " \
-         "${bare_pkgs}"
+         "${rtems_pkgs}"
     ../source-builder/sb-set-builder --dry-run --with-download \
                                      --without-error-report \
                                      --without-release-url \
-                                     ${bare_pkgs}
-    #
-    # If svn or cvs exist the release fails.
+                                     ${rtems_pkgs}
+
+    # If git, svn or cvs exist the release fails.
     #
-    if [ -d sources/svn -o -d sources/cvs ]; then
+    if [ -d sources/git -o -d sources/svn -o -d sources/cvs ]; then
      echo "error: ${release} contains repositories and cannot be released."
      exit 1
     fi
     #
-    # If there are git repos create packages of them as they are.
+    # Clean out the packages we do not places in 'sources' we copied in..
     #
-    if [ -d sources/git ]; then
-     cd sources
-      cd git
-       for g in $(ls)
-       do
-        cd ${g}
-         hash=$(git status | grep '^HEAD detached at ' | sed 's/^HEAD detached at //')
-         prefix=$(echo ${g}-${hash} | sed 's/\./\-/')
-         echo "Packaging GIT repo: ${g} to ${prefix}"
-         git archive --format=tar --prefix=${prefix}/ ${hash} | xz > ../../${prefix}.tar.xz
-         cd ..
-       done
-       cd ..
-       rm -rf git
-      cd ..
-    fi
-    cd ..
-  fi
-  #
-  # Export the sources and patches.
-  #
-  rm -rf ${top}/${release}/sources
-  mkdir ${top}/${release}/sources
-  for p in ${export_source}
-  do
-   cp ${p}/sources/* ${top}/${release}/sources/
-   cp ${p}/patches/* ${top}/${release}/sources/
-  done
-  cd ..
-
- cd ..
- rm -rf ${workspace}
+    for p in rtems-tools rtems
+    do
+     rm sources/${p}-${release}.tar.xz
+    done
+    cd ..    # rtems
 
- cd ${release}/sources
-  rm -f ${checksum}sum.txt
-  for f in $(ls -1)
-  do
-   if [ ! -d ${f} ]; then
-    csum=$(${checksum} -q ${f})
-    echo "${csum} ${f}" >> ${checksum}sum.txt
+   #
+   # Fetch the source for 3rd party packages tools.
+   #
+   if [ -n "${bare_pkgs}" -a "${bare_pkgs}" != "None" ]; then
+    cd bare
+     export_source="${export_source} bare"
+     mkdir sources patches
+     echo "../source-builder/sb-set-builder --dry-run --with-download " \
+          "--without-error-report --without-release-url " \
+          "${bare_pkgs}"
+     ../source-builder/sb-set-builder --dry-run --with-download \
+                                      --without-error-report \
+                                      --without-release-url \
+                                      ${bare_pkgs}
+     #
+     # If svn or cvs exist the release fails.
+     #
+     if [ -d sources/svn -o -d sources/cvs ]; then
+      echo "error: ${release} contains repositories and cannot be released."
+      exit 1
+     fi
+     #
+     # If there are git repos create packages of them as they are.
+     #
+     if [ -d sources/git ]; then
+      cd sources
+       cd git
+        for g in $(ls)
+        do
+         cd ${g}
+          hash=$(git status | grep '^HEAD detached at ' | sed 's/^HEAD detached at //')
+          prefix=$(echo ${g}-${hash} | sed 's/\./\-/')
+          echo "Packaging GIT repo: ${g} to ${prefix}"
+          git archive --format=tar --prefix=${prefix}/ ${hash} | xz > ../../${prefix}.tar.xz
+          cd ..  # ${g}
+        done
+        cd ..   # git
+       rm -rf git
+       cd ..   # source
+     fi
+     cd ..   # ${bare}
    fi
-  done
-  cd ..
- cd ..
+   #
+   # Export the sources and patches.
+   #
+   rm -rf ${top}/${release}/sources
+   mkdir ${top}/${release}/sources
+   for p in ${export_source}
+   do
+    cp ${p}/sources/* ${top}/${release}/sources/
+    cp ${p}/patches/* ${top}/${release}/sources/
+   done
+   cd ..   # ${prefix}
+  cd ..   # ${workspace}
+
+  rm -rf ${workspace}
+
+  cd sources
+   rm -f ${checksum}sum.txt
+   for f in $(ls -1)
+   do
+    if [ ! -d ${f} ]; then
+     csum=$(${checksum} -q ${f})
+     echo "${csum} ${f}" >> ${checksum}sum.txt
+    fi
+   done
+   cd ..   # sources
+  cd ..   # ${release}
 
 echo "Created: ${release}/sources/${checksum}sum.txt"
 echo "Created: ${release}/sources"