From e1b89b0a374d91b3a60c08895e743ae060da0fe5 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Fri, 1 May 2020 18:38:41 +1000 Subject: Generate README.txt and index.html from markdown - Update to support ARCH-BSPS.md from an updated kernel tool --- README.md.in | 164 +++++++++++++++++++++++++++++ README.txt.in | 126 ----------------------- rtems-notes-4.11.txt | 42 ++++++++ rtems-notes-5.txt | 126 ++++++++++++++--------- rtems-release | 52 ++++++++-- rtems-release-4.10-conf | 1 + rtems-release-4.11-conf | 8 -- rtems-release-defaults | 3 +- rtems-release-info | 60 +++++------ rtems-release-kernel | 3 +- rtems-release-notes.css | 267 ++++++++++++++++++++++++++++++++++++++++++++++++ 11 files changed, 628 insertions(+), 224 deletions(-) create mode 100644 README.md.in delete mode 100644 README.txt.in create mode 100644 rtems-notes-4.11.txt create mode 100644 rtems-release-notes.css diff --git a/README.md.in b/README.md.in new file mode 100644 index 0000000..c2a377a --- /dev/null +++ b/README.md.in @@ -0,0 +1,164 @@ +**Home:**: <@RELEASE_URL@> +**Release:** @RELEASE@ +**Date:** @DATE@ + +[RN-P]: rtems-@RELEASE@-release-notes.pdf + +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, RISCV, MIPS, NIOS-II, +Microblaze and more (a full list is provided at the end). + +This release directory contains the source code for the RTEMS @RELEASE@ +operating system and tools. All the documenation provided in HTML and PDF +formats. + +Please drop by the Users mailing list (users@rtems.org) and let us know how +you are using RTEMS. We love hearing about user projects. + +Many thanks to everyone who helped create this release. + +Regards +*The RTEMS Development Team.* + +## RTEMS Web Sites + +--------- ------------------------------------------ + Home + Download + Wiki + Docs + Bugs + Lists +Developer + GIT +--------- ------------------------------------------ + +## Release Files + +-------------------------------------------------------------------------------- +@RELEASE@ Top level directory +------------------------------------ ---------------------------------- +[README.txt](README.txt), `index.html` This document + +[contrib](contrib) Directory contains extra release + related files + +[docs](docs) The generated RTEMS documentation + +[sources](souces) Source code for this release + +[rtems-@RELEASE@-release-notes.pdf][RN-P] Detailed RTEMS Release notes + +[sha512sum.txt](sha512sum.txt) The SHA512 checksums for this + directory +------------------------------------------------------------------------------- + +[S-K]: sources/rtems-@RELEASE@.tar.xz +[S-RSB]: sources/rtems-source-builder-@RELEASE@.tar.xz +[S-T]: sources/rtems-tools-@RELEASE@.tar.xz +[S-DOC]: sources/rtems-docs-@RELEASE@.tar.xz +[S-BSD]: sources/rtems-libbsd-@RELEASE@.tar.xz +[S-EX]: sources/rtems-examples-@RELEASE@.tar.xz + + +Source Downloads | RTEMS Source Code +-----------------------------------------------|--------------------------------------- +[rtems-@RELEASE@.tar.xz][S-K] | RTEMS kernel +[rtems-source-builder-@RELEASE@.tar.xz][S-RSB] | RTEMS Source Builder +[rtems-tools-@RELEASE@.tar.xz][S-T] | RTEMS Tools +[rtems-docs-@RELEASE@.tar.xz][S-DOC] | RTEMS Documentation source +[rtems-libbsd-@RELEASE@.tar.xz][S-BSD] | RTEMS LibBSD +[rtems-examples-@RELEASE@.tar.xz][S-EX] | RTEMS Examples +[sources](souces) | All source code for this release +[sha512sum.txt](sha512sum.txt) | SHA512 checksums for this directory + +## RTEMS Documentation + +[D-U-P]: docs/rtems-@RELEASE@-user.pdf +[D-U-H]: docs/rtems-@RELEASE@-user-html.tar.xz +[D-C-P]: docs/rtems-@RELEASE@-c-user.pdf +[D-C-H]: docs/rtems-@RELEASE@-c-user-html.tar.xz +[D-P-P]: docs/rtems-@RELEASE@-posix-user.pdf +[D-P-H]: docs/rtems-@RELEASE@-posix-user-html.tar.xz +[D-E-P]: docs/rtems-@RELEASE@-eng.pdf +[D-E-H]: docs/rtems-@RELEASE@-eng-html.tar.xz +[D-N-P]: docs/rtems-@RELEASE@-networking.pdf +[D-N-H]: docs/rtems-@RELEASE@-networking-html.tar.xz +[D-S-P]: docs/rtems-@RELEASE@-shell.pdf +[D-S-H]: docs/rtems-@RELEASE@-shell-html.tar.xz +[D-O-H]: docs/rtems-@RELEASE@-doxygen-html.tar.xz + +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-@RELEASE@-user.pdf][D-U-P] + * [docs/rtems-@RELEASE@-user-html.tar.xz][D-U-H] + +RTEMS C User Manual + ~ * [docs/rtems-@RELEASE@-c-user.pdf][D-C-P] + * [docs/rtems-@RELEASE@-c-user-html.tar.xz][D-C-H] + +RTEMS POSIX User Manual + ~ * [docs/rtems-@RELEASE@-posix-user.pdf][D-P-P] + * [docs/rtems-@RELEASE@-posix-user-html.tar.xz][D-P-H] + +RTEMS Software Engineering Manual + ~ * [docs/rtems-@RELEASE@-eng.pdf][D-E-P] + * [docs/rtems-@RELEASE@-eng-html.tar.xz][D-E-H] + +RTEMS Networking User Manual + ~ * [docs/rtems-@RELEASE@-networking.pdf][D-N-P] + * [docs/rtems-@RELEASE@-networking-html.tar.xz][D-N-H] + +RTEMS Shell User Manual + ~ * [docs/rtems-@RELEASE@-shell.pdf][D-S-P] + * [docs/rtems-@RELEASE@-shell-html.tar.xz][D-S-H] + +RTEMS Doxygen + ~ * [docs/rtems-@RELEASE@-doxygen.pdf][D-O-H] + +## Quick Guide to Building + +For new user rhe Quick Start in the User Manual contains a details Quick Start +guide. Download the User Manual: + + <@RELEASE_URL@/docs/rtems-docs-@RELEASE@-user.pdf> + +and follow the instructions in the Quick Start section. If are familiar with +RTEMS or just want to get going the following steps will download the RTEMS +Source Builder: + +~~~~~~~ +cd +mkdir -p development/rtems +cd development/rtems +wget @RELEASE_URL@/sources/rtems-source-builder-@RELEASE@.tar.xz +tar Jxf rtems-source-builder-@RELEASE@.tar.xz +cd rtems-source-builder-@RELEASE@/rtems +~~~~~~~ + +To build the tools for the ARM architecture: + +~~~~~~~ +../source-builder/sb-set-builder \ + --prefix=$HOME/development/rtems/@RELEASE@ \ + @VERSION@/rtems-arm +~~~~~~~ + +To build the tools, kernel and all packages for the Beagleboneblack: + +~~~~~~~ +../source-builder/sb-set-builder \ + --prefix=$HOME/development/rtems/@RELEASE@ \ + @VERSION@/bsps/beagleboneblack +~~~~~~~ + +If you encounter a problem please post to the user@rtems.org mailing list. You +can join the Users mailing at . + +If you find a bug please raise a ticket at . diff --git a/README.txt.in b/README.txt.in deleted file mode 100644 index 2f95163..0000000 --- a/README.txt.in +++ /dev/null @@ -1,126 +0,0 @@ -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, RISCV, MIPS, NIOS-II, -Microblaze and more (a full list is provided at the end). - -This release directory contains the source code for the RTEMS @RELEASE@ -operating system and tools. All the documenation provided in HTML and PDF -formats. - -The release note are contained in: - - <@RELEASE_URL@/rtems-@RELEASE@-release-notes.pdf> - -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 : - Download : - Wiki : - Docs : - Bugs : - Lists : - Developer : - GIT : - -Release Files -------------- - -@TABLE-START@ - - README.txt | This document. - - contrib | Directory contains extra release related files. - - docs: | The generated RTEMS documentation. - - RTEMS Documentation | See below. - - sources: | The source code for this release. - - 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-libbsd-@RELEASE@.tar.xz | The RTEMS LibBSD source. - - rtems-examples-@RELEASE@.tar.xz | The RTEMS Examples source. - - rtems-@RELEASE@-release-notes.pdf | The RTEMS Release notes. - - sha512sum.txt | The SHA512 checksums for this directory. -@TABLE-END@ - -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` - - - RTEMS Doxygen - - `docs/rtems-docs-@RELEASE@-shell.pdf` - - `docs/rtems-docs-@RELEASE@-shell-html.tar.xz` - -Quick Guide to Building -~~~~~~~~~~~~~~~~~~~~~~~ - -For new user rhe Quick Start in the User Manual contains a details Quick Start -guide. Download the User Manual: - - <@RELEASE_URL@/docs/rtems-docs-@RELEASE@-user.pdf> - -and follow the instructions in the Quick Start section. If are familiar with -RTEMS or just want to get going the following steps will download the RTEMS -Source Builder: -``` - cd - mkdir -p development/rtems - cd development/rtems - wget @RELEASE_URL@/sources/rtems-source-builder-@RELEASE@.tar.xz - tar Jxf rtems-source-builder-@RELEASE@.tar.xz - cd rtems-source-builder-@RELEASE@/rtems -``` -To build the tools for the ARM architecture: -``` - ../source-builder/sb-set-builder \ - --prefix=$HOME/development/rtems/@RELEASE@ \ - @VERSION@/rtems-arm -``` -To build the tools, kernel and all packages for the Beagleboneblack: -``` - ../source-builder/sb-set-builder \ - --prefix=$HOME/development/rtems/@RELEASE@ \ - @VERSION@/bsps/beagleboneblack -``` -If you encounter a problem please post to the user@rtems.org mailing list. You -can join the Users mailing at https://lists.rtems.org/. - -If you find a bug please raise a ticket at https://devel.rtems.org/newticket. diff --git a/rtems-notes-4.11.txt b/rtems-notes-4.11.txt new file mode 100644 index 0000000..d9a2809 --- /dev/null +++ b/rtems-notes-4.11.txt @@ -0,0 +1,42 @@ +#! /bin/sh +# +# RTEMS Tools Project (http://www.rtems.org/) +# Copyright 2015-2017 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 overridded configuration for 4.11. +# +rtems_readme_release_notes="$(cat <<- EOF +- The rtems-libbsd package is experimental in this release. + You need to closely evaluate it's suitablility for production. + +- SMP support is experimental in this release and we recommend a + later release. +EOF +)" diff --git a/rtems-notes-5.txt b/rtems-notes-5.txt index 5b23997..ddc2597 100644 --- a/rtems-notes-5.txt +++ b/rtems-notes-5.txt @@ -1,6 +1,6 @@ -= 5.1 Release Notes = +## RTEMS 5.1 Release Notes -== RTEMS Improvements +### RTEMS Improvements In this section, we discuss public API level changes as well as improvements to the implementation of those API routines. @@ -16,91 +16,125 @@ Implementation improvements usually fall into one of the following categories: * Algorithm improvements in execution time or memory usage * Critical section reduction -== API Changes +### API Changes * Most services use now statically allocated resources and no longer need accounting in the application configuration. * The work area initialization (RTEMS Work Space and C Program Heap) changed. - BSPs must provide now a _Memory_Get() function. + BSPs must provide now a `_Memory_Get()` function. * POSIX timers and signals are now the only POSIX resources which are enabled by the POSIX API. -=== API Additions +#### API Additions * Support for recording of high-frequency events in particular on SMP systems * Support for thread pinning (enables support for Epoch Based Reclamation; used by libbsd) * Termios supports now generation of signals. * New fatal sources: - * RTEMS_FATAL_SOURCE_EXCEPTION - * RTEMS_FATAL_SOURCE_PANIC - * RTEMS_FATAL_SOURCE_SMP - * RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE - * RTEMS_FATAL_SOURCE_HEAP + * `RTEMS_FATAL_SOURCE_EXCEPTION` + * `RTEMS_FATAL_SOURCE_PANIC` + * `RTEMS_FATAL_SOURCE_SMP` + * `RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE` + * `RTEMS_FATAL_SOURCE_HEAP` -== API Implementation Improvements +#### API Implementation Improvements * TBD -== API Deprecations +#### API Deprecations -* rtems_iterate_over_all_threads(). Use rtems_task_iterate() instead. +* `rtems_iterate_over_all_threads()`. Use `rtems_task_iterate()` instead. -== API Removals +#### API Removals -* rtems_clock_get() +* `rtems_clock_get()` -== Configuration Changes +### Configuration Changes * All configuration options are now documented. * Most resources are now statically allocated and no longer use the workspace. * New configuration options: - * CONFIGURE_DIRTY_MEMORY - * CONFIGURE_RECORD_EXTENSIONS_ENABLED - * CONFIGURE_RECORD_FATAL_DUMP_BASE64 - * CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB - * CONFIGURE_RECORD_PER_PROCESSOR_ITEMS - * CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION + * `CONFIGURE_DIRTY_MEMORY` + * `CONFIGURE_RECORD_EXTENSIONS_ENABLED` + * `CONFIGURE_RECORD_FATAL_DUMP_BASE64` + * `CONFIGURE_RECORD_FATAL_DUMP_BASE64_ZLIB` + * `CONFIGURE_RECORD_PER_PROCESSOR_ITEMS` + * `CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION` * Removed configuration options: - * CONFIGURE_HAS_OWN_CONFIGURATION_TABLE - * CONFIGURE_HAS_OWN_BDBUF_TABLE - * CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE - * CONFIGURE_HAS_OWN_FILESYSTEM_TABLE - * CONFIGURE_HAS_OWN_INIT_TABLE - * CONFIGURE_HAS_OWN_MOUNT_TABLE - * CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE - * CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE + * `CONFIGURE_HAS_OWN_CONFIGURATION_TABLE` + * `CONFIGURE_HAS_OWN_BDBUF_TABLE` + * `CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE` + * `CONFIGURE_HAS_OWN_FILESYSTEM_TABLE` + * `CONFIGURE_HAS_OWN_INIT_TABLE` + * `CONFIGURE_HAS_OWN_MOUNT_TABLE` + * `CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE` + * `CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE` * The helper macro for the clustered scheduler configuration - RTEMS_SCHEDULER_EDF_SMP() has now only one parameter. + `RTEMS_SCHEDULER_EDF_SMP()` has now only one parameter. -== RTEMS Shell Improvements +## RTEMS Shell Improvements The following improvements were made to the RTEMS Shell: -* TBD +* Telnet now supports `joel` script output. Running a `joel` script in a + telnet session now sees the output. Nested `joel` scripts also output to the + telnet session. + +## General -== General +* API header files have been collected from the various locations in the RTEMS + source tree and placed under `cputkit/include` and for BSPs under + `bsps/include`. There is no header pre-install phase when building RTEMS. + +* Improved parallel build performance. Nested `make` calls now run in + parallel. * Added support for the RISC-V 32-bit and 64-bit architecture. + * Added support for the 64-bit PowerPC architecture using the ELFv2 ABI. -* Synchronized support for Journalling Flash File System, Version 2 (JFFS2) with Linux 4.17. + +* Synchronized support for Journalling Flash File System, Version 2 (JFFS2) + with Linux 4.17. + * Import of libfdt from device tree compiler project. -== BSPs and Device Drivers +* Added `libdebugger`, a thread aware GDB debug server with TCP transport + support. Currently the supported architectures are i386 and ARM. The ARM + support is experimental. + +* This is the last release of RTEMS with the `autoconf`/`automake` build + system. RTEMS will be moving to a `waf` based build system driven from YAML + specifications files. The effort is part of the on-going wotk in the RTEMS + project to support qualification of the operating system. + +## BSPs and Device Drivers * General - * TBD + * BSP source code moved from `c/src/lib/libbsd` to `bsps` in the + source tree. The configure and some other related pieces are still + held in the original path. * New BSPs - * BSPs for ARM - * atsamv - Microchip (former Atmel) SAM V71 series - * xilinx-zynqmp - Xilinx Zynq UltraScale+ MPSoC platform + * BSPs for ARM + * `atsamv` - Microchip (former Atmel) SAM V71 series + * `xilinx-zynqmp` - Xilinx Zynq UltraScale+ MPSoC platform * BSPs for RISC-V - * riscv - Family of generic BSPs - * griscv - BSP based on the GRLIB + * `riscv` - Family of generic BSPs + * `griscv` - BSP based on the GRLIB * Significant updates to existing BSPs - * powerpc/qoriq: 64-bit support + * `powerpc/qoriq`: 64-bit support * Removal of obsoleted BSPs - * TBD + * `gdbsim` * Drivers - * Drivers for getentropy() - * TBD + * Drivers for `getentropy()` + +## Ecosystem + +* RSB support to build a BSP software stack of tools, kernel, libbsd, and + supported 3rd party packages. + +* RTEMS Tester (`rtems-test`) support for DHCP/TFTP target hardware testing. + +* RTEMS Trace addition of a new trace record support for target tracing. + +* RTEMS Bootimage, a tool to portability create SD card images. diff --git a/rtems-release b/rtems-release index a498005..b66ace3 100755 --- a/rtems-release +++ b/rtems-release @@ -48,6 +48,15 @@ export release_top=${PWD} # . ${release_top}/rtems-release-defaults +# +# We need pandoc so generate an error early is not available. +# +if [ ! $(command -v pandoc) ]; then + echo "error: pandoc not found, please install" >&2 + exit 1 +fi + +# # # Usage for this tool. # @@ -89,6 +98,16 @@ revision=$2 release=${version}.${revision} +# +# Does the release provide release notes? +# +if [ -f rtems-notes-${version}.txt ]; then + rtems_readme_release_notes=rtems-notes-${version}.txt +fi + +# +# This call lets us have smaller lines in this script. +# build() { echo "Package: $1" @@ -98,8 +117,11 @@ build() # # Clean the release directory away. # -rm -rf ${release} -mkdir ${release} +if [ -e ${release} ]; then + echo "Removing existing release ${release}" + rm -rf ${release} + mkdir ${release} +fi # # Package the RSB, must be before the kernel. The kernel worker script uses the @@ -143,6 +165,11 @@ fi echo "Collect tools sources" ./rtems-release-sources ${version} ${revision} ${release_url} +# +# Make the contrib directory +# +mkdir -p ${release}/contrib/rtems-release + # # Create the release information # @@ -153,23 +180,36 @@ echo "Create the release information" # # Copy these release scripts to a contrib directory. # -mkdir -p ${release}/contrib/releasing for f in README.txt \ - README.txt.in \ + ${rtems_readme} \ + rtems-mailer \ rtems-release \ + ${rtems_readme_release_notes} \ ${rtems_release_conf} \ + rtems-release-cron \ rtems-release-docs \ + rtems-release-defaults \ + rtems-release-info \ rtems-release-kernel \ + rtems-release-notes \ + $(find rtems-release-notes-coverpage -type f) \ + rtems-release-notes.css \ rtems-release-package \ rtems-release-package-end \ rtems-release-package-start \ + rtems-release-path \ rtems-release-rsb-version \ rtems-release-sources \ + rtems-release-tag \ + rtems-release-version \ rtems-source-packages do - cp ${f} ${release}/contrib/releasing/ + if [ ! -e $(dirname ${f}) ]; then + mkdir -p $(dirname ${f}) + fi + cp ${f} ${release}/contrib/rtems-release/ csum=$(${checksum} -q ${f}) - echo "${csum} ${f}" >> ${release}/contrib/releasing/${checksum}sum.txt + echo "${csum} ${f}" >> ${release}/contrib/rtems-release/${checksum}sum.txt done # diff --git a/rtems-release-4.10-conf b/rtems-release-4.10-conf index 5f6aa6a..98a569f 100755 --- a/rtems-release-4.10-conf +++ b/rtems-release-4.10-conf @@ -35,4 +35,5 @@ rtems_libbsd=no rtems_docs=no rtems_release_notes=no +rtems_readme_release_notes= rtems_readme=README-4.10.txt.in diff --git a/rtems-release-4.11-conf b/rtems-release-4.11-conf index d9a2809..a6e7efc 100755 --- a/rtems-release-4.11-conf +++ b/rtems-release-4.11-conf @@ -32,11 +32,3 @@ # # The script is the overridded configuration for 4.11. # -rtems_readme_release_notes="$(cat <<- EOF -- The rtems-libbsd package is experimental in this release. - You need to closely evaluate it's suitablility for production. - -- SMP support is experimental in this release and we recommend a - later release. -EOF -)" diff --git a/rtems-release-defaults b/rtems-release-defaults index 60d9721..0ea3954 100755 --- a/rtems-release-defaults +++ b/rtems-release-defaults @@ -61,8 +61,9 @@ rtems_examples=yes rtems_libbsd=yes rtems_docs=yes rtems_docs_build=sphinx +rtems_release_info_html=no rtems_release_notes=yes -rtems_readme=README.txt.in +rtems_readme=README.md.in rtems_readme_release_notes= rtems_release_conf= rtems_release_url=https://ftp.rtems.org/pub/rtems/releases diff --git a/rtems-release-info b/rtems-release-info index d4a4f61..2f8c80a 100644 --- a/rtems-release-info +++ b/rtems-release-info @@ -34,39 +34,29 @@ . ${release_top}/rtems-release-path # -# Create the README.txt. -# -# The initial stage is done in a few steps where the release files table is cut -# out of the input template file and formatted using the column command and -# inserted back. -# -cat ${rtems_readme} | \ - sed -e "s/@RELEASE_URL@/${escaped_release_path}/g" \ - -e "s/@RELEASE@/${release}/g" \ - -e "s/@VERSION@/${version}/g" \ - -e "s/@REVISION@/${revision}/g" \ - -e "s/@DATE@/${now}/g" > ${release}/README.1.txt -cat ${release}/README.1.txt | \ - sed -n '/^@TABLE-START@/,/^@TABLE-END@/p' | \ - sed -e 's/@TABLE-START@//g' -e 's/@TABLE-END@//g' | \ - column -s '|' -t | \ - sed -e 's/$/\\/' > ${release}/README.2.txt -cat ${release}/README.1.txt | \ - sed -e "/@TABLE-START@/,/@TABLE-END@/c\\ -$(cat ${release}/README.2.txt)" > ${release}/README.3.txt -cat ${release}/README.3.txt | \ - sed -e "s/[\`\<\>]//g" -e 's/[[:space:]]*$//' > ${release}/README.txt -rm -f ${release}/README.1.txt ${release}/README.2.txt ${release}/README.3.txt -if [ -n "${rtems_readme_release_notes}" ]; then - echo >> ${release}/README.txt - echo "Release Notes" >> ${release}/README.txt - echo "~~~~~~~~~~~~~" >> ${release}/README.txt - echo >> ${release}/README.txt - echo "${rtems_readme_release_notes}" >> ${release}/README.txt -fi -echo >> ${release}/README.txt -echo "RTEMS Architectures and BSPs" >> ${release}/README.txt -echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~" >> ${release}/README.txt +# Create the README.md and from that README.txt and index.html +# +echo " +## Architectures and BSPs +" | \ + cat ${rtems_readme} ${rtems_readme_release_notes} - ARCH-BSP.md | \ + sed -e "s/@RELEASE_URL@/${escaped_release_path}/g" \ + -e "s/@RELEASE@/${release}/g" \ + -e "s/@VERSION@/${version}/g" \ + -e "s/@REVISION@/${revision}/g" \ + -e "s/@RTEMS_RELEASE_NOTES@/${release_notes}/g" \ + -e "s/@DATE@/${now}/g" > ${release}/contrib/README.md +rm ARCH-BSP.md + +title="RTEMS ${version} Embedded Realtime Operating System" + +pandoc_std_opts="-f markdown_phpextra+grid_tables+multiline_tables+simple_tables+auto_identifiers --section-divs" + +echo "${title}" > ${release}/README.txt echo >> ${release}/README.txt -cat ARCH-BSP.txt >> ${release}/README.txt -rm ARCH-BSP.txt +pandoc ${release}/contrib/README.md \ + ${pandoc_std_opts} -t plain >> ${release}/README.txt + +pandoc ${release}/contrib/README.md \ + ${pandoc_std_opts} --toc -M title="${title}" -t html \ + --include-in-header=rtems-release-notes.css > ${release}/index.html diff --git a/rtems-release-kernel b/rtems-release-kernel index b3a8290..f182996 100755 --- a/rtems-release-kernel +++ b/rtems-release-kernel @@ -110,8 +110,7 @@ EOF echo "Cleaning autom4te.cache" rm -rf $(find . -name autom4te.cache) echo "Generate ARCH-BSP.txt" - ./rtems-bsps > ARCH-BSP.txt - cp ARCH-BSP.txt ${toptop} + ./rtems-bsps -m > ${toptop}/ARCH-BSP.md echo "Generate README" cp README README.tmp cat README.tmp | \ diff --git a/rtems-release-notes.css b/rtems-release-notes.css new file mode 100644 index 0000000..b5a0fbb --- /dev/null +++ b/rtems-release-notes.css @@ -0,0 +1,267 @@ + -- cgit v1.2.3