From 6b84d3dde2944b6eaf0dd2afb33a76a4cfd2c19b Mon Sep 17 00:00:00 2001 From: David Chisnall Date: Tue, 7 Nov 2023 09:37:26 +0000 Subject: [PATCH] Add book to cheriot.org. --- Gemfile | 1 + _config.yml | 1 + ...023-11-06-cheriot-programmers-guide.markdown | 17 +++++++++++++++++ book.markdown | 4 ++++ 4 files changed, 23 insertions(+) create mode 100644 _posts/2023-11-06-cheriot-programmers-guide.markdown create mode 100644 book.markdown diff --git a/Gemfile b/Gemfile index 2b345e5..912a867 100644 --- a/Gemfile +++ b/Gemfile @@ -19,6 +19,7 @@ gem "minimal-mistakes-jekyll" group :jekyll_plugins do gem "jekyll-feed", "~> 0.12" gem 'jekyll-scholar' + gem 'jekyll-redirect-from' end diff --git a/_config.yml b/_config.yml index 4092d58..e05ac3f 100644 --- a/_config.yml +++ b/_config.yml @@ -12,6 +12,7 @@ theme: minima plugins: - jekyll-feed - jekyll-scholar + - jekyll-redirect-from markdown: kramdown kramdown: diff --git a/_posts/2023-11-06-cheriot-programmers-guide.markdown b/_posts/2023-11-06-cheriot-programmers-guide.markdown new file mode 100644 index 0000000..66a3189 --- /dev/null +++ b/_posts/2023-11-06-cheriot-programmers-guide.markdown @@ -0,0 +1,17 @@ +--- +layout: post +title: "CHERIoT Programmers' Guide drafts online" +date: 2023-11-06T15:49+00:00 +categories: book guide +--- + +You might have noticed a link in the header to the [CHERIoT Programmers' Guide](https://cheriot.org/book). +This is an early public draft and will be written in in full view of a live audience of tens (optimistically) of avid readers! + +This is using [AsciiDoxy](https://asciidoxy.org), which can parse Doxygen XML and generate AsciiDoc output, to include documentation for the CHERIoT RTOS APIs. +Doxygen, in turn, can use libclang for parsing. +The [book build container](https://github.com/CHERIoT-Platform/book/pkgs/container/book-build-container) contains a version of Doxygen built with the version of libclang from the CHERIoT compiler, which can then recognise the CHERIoT-specific attributes. +This lets it directly reference the RTOS source and should make it easy to update as the code evolves. + +Currently, all of the cross references that go between chapters are broken in the HTML version and there are likely to be a lot of other errors (typographical, factual, and grammatical). +This is a live document and will evolve over time, hopefully leading to fewer errors both in absolute numbers and as a proportion of the total text. diff --git a/book.markdown b/book.markdown new file mode 100644 index 0000000..f76bf54 --- /dev/null +++ b/book.markdown @@ -0,0 +1,4 @@ +--- +title: The CHERIoT Programmers' Guide +redirect_to: https://cheriot.org/book +---