[rtems-release commit] Provide the HTML as browseable from the release.

Chris Johns chrisj at rtems.org
Sat Aug 15 00:22:36 UTC 2020


Module:    rtems-release
Branch:    master
Commit:    db3a192f55aee24f472171513296d0131f1ad409
Changeset: http://git.rtems.org/rtems-release/commit/?id=db3a192f55aee24f472171513296d0131f1ad409

Author:    Chris Johns <chrisj at rtems.org>
Date:      Wed Aug 12 17:04:36 2020 +1000

Provide the HTML as browseable from the release.

---

 README.md.in       | 35 ++++++++++++++++++++++++++---------
 rtems-release-docs | 12 ++++++++++++
 2 files changed, 38 insertions(+), 9 deletions(-)

diff --git a/README.md.in b/README.md.in
index 4f6d4ba..b919e81 100644
--- a/README.md.in
+++ b/README.md.in
@@ -84,50 +84,67 @@ Source Downloads                               | RTEMS Source Code
 
 ## RTEMS Documentation
 
+[D-O]:   docs/html
+[D-U-O]: docs/html/user
 [D-U-P]: docs/rtems- at RELEASE@-user.pdf
 [D-U-H]: docs/rtems- at RELEASE@-user-html.tar.xz
+[D-C-O]: docs/html/c-user
 [D-C-P]: docs/rtems- at RELEASE@-c-user.pdf
 [D-C-H]: docs/rtems- at RELEASE@-c-user-html.tar.xz
+[D-P-O]: docs/html/posix-users
 [D-P-P]: docs/rtems- at RELEASE@-posix-users.pdf
 [D-P-H]: docs/rtems- at RELEASE@-posix-users-html.tar.xz
+[D-E-O]: docs/html/eng
 [D-E-P]: docs/rtems- at RELEASE@-eng.pdf
 [D-E-H]: docs/rtems- at RELEASE@-eng-html.tar.xz
+[D-N-O]: docs/html/networking
 [D-N-P]: docs/rtems- at RELEASE@-networking.pdf
 [D-N-H]: docs/rtems- at RELEASE@-networking-html.tar.xz
+[D-S-O]: docs/html/shell
 [D-S-P]: docs/rtems- at RELEASE@-shell.pdf
 [D-S-H]: docs/rtems- at RELEASE@-shell-html.tar.xz
+[D-O-O]: docs/html/doxygen
 [D-O-H]: docs/rtems- at RELEASE@-doxygen-html.tar.xz
 
-The generated documentation can be found in the `docs` directory.
+[Online RTEMS @RELEASE@ Documentation][D-O]
 
-The following manuals are available as compress HTML tar files or PDF:
+The generated documentation packages can be found in the `docs` directory.
+
+The following manuals are available as compressed HTML tar files or PDF:
 
 RTEMS User Manual
-  ~ * [docs/rtems- at RELEASE@-user.pdf][D-U-P]
+  ~ * [docs/html/user][D-U-O]
+    * [docs/rtems- at RELEASE@-user.pdf][D-U-P]
     * [docs/rtems- at RELEASE@-user-html.tar.xz][D-U-H]
 
 RTEMS C User Manual
-  ~ * [docs/rtems- at RELEASE@-c-user.pdf][D-C-P]
+  ~ * [docs/html/c-user][D-C-O]
+    * [docs/rtems- at RELEASE@-c-user.pdf][D-C-P]
     * [docs/rtems- at RELEASE@-c-user-html.tar.xz][D-C-H]
 
 RTEMS POSIX User Manual
-  ~ * [docs/rtems- at RELEASE@-posix-users.pdf][D-P-P]
+  ~ * [docs/html/posix-users][D-P-O]
+    * [docs/rtems- at RELEASE@-posix-users.pdf][D-P-P]
     * [docs/rtems- at RELEASE@-posix-users-html.tar.xz][D-P-H]
 
 RTEMS Software Engineering Manual
-  ~ * [docs/rtems- at RELEASE@-eng.pdf][D-E-P]
+  ~ * [docs/html/eng][D-E-O]
+    * [docs/rtems- at RELEASE@-eng.pdf][D-E-P]
     * [docs/rtems- at RELEASE@-eng-html.tar.xz][D-E-H]
 
 RTEMS Networking User Manual
-  ~ * [docs/rtems- at RELEASE@-networking.pdf][D-N-P]
+  ~ * [docs/html/networking][D-N-O]
+    * [docs/rtems- at RELEASE@-networking.pdf][D-N-P]
     * [docs/rtems- at RELEASE@-networking-html.tar.xz][D-N-H]
 
 RTEMS Shell User Manual
-  ~ * [docs/rtems- at RELEASE@-shell.pdf][D-S-P]
+  ~ * [docs/html/shell][D-S-O]
+    * [docs/rtems- at RELEASE@-shell.pdf][D-S-P]
     * [docs/rtems- at RELEASE@-shell-html.tar.xz][D-S-H]
 
 RTEMS Doxygen
-  ~ * [docs/rtems- at RELEASE@-doxygen-html.tar.xz][D-O-H]
+  ~ * [docs/html/doxygen][D-O-O]
+    * [docs/rtems- at RELEASE@-doxygen-html.tar.xz][D-O-H]
 
 ## Quick Guide to Building
 
diff --git a/rtems-release-docs b/rtems-release-docs
index 7125067..acfcfc5 100755
--- a/rtems-release-docs
+++ b/rtems-release-docs
@@ -178,6 +178,18 @@ cd ${release}/${docs}
   fi
  done
 
+ #
+ # Provide the documentation and doxygen available online in the release
+ #
+ mkdir html
+ cd html
+  tar Jxf ../rtems-${release}-docs-all.tar.${comp_ext}
+  mv rtems-docs-${release}/* .
+  rm -rf rtems-docs-${release}
+  tar Jxf ../rtems-${release}-doxygen-html.tar.${comp_ext}
+  mv rtems-doxygen-${release} doxygen
+  cd ..
+
  rm -f ${checksum}sum.txt
  for f in $(ls -1)
  do



More information about the vc mailing list