From: Johnny Richard <johnny@johnnyrichard.com>
To: ~johnnyrichard/olang-devel@lists.sr.ht
Cc: Johnny Richard <johnny@johnnyrichard.com>
Subject: [PATCH olang v1 1/3] docs: move language spec to manual document
Date: Mon, 16 Sep 2024 18:29:12 +0200 [thread overview]
Message-ID: <20240916163004.43389-2-johnny@johnnyrichard.com> (raw)
In-Reply-To: <20240916163004.43389-1-johnny@johnnyrichard.com>
Signed-off-by: Johnny Richard <johnny@johnnyrichard.com>
---
docs/manual/Makefile | 2 +-
| 1 -
docs/manual/olang.texi | 3 +++
.../specification.texi} | 13 ++++++-------
docs/template.html | 1 -
5 files changed, 10 insertions(+), 10 deletions(-)
rename docs/{pages/language-specification.md => manual/specification.texi} (97%)
diff --git a/docs/manual/Makefile b/docs/manual/Makefile
index 59aeb03..b2d29a4 100644
--- a/docs/manual/Makefile
+++ b/docs/manual/Makefile
@@ -4,7 +4,7 @@ HTML_HEADER=$(shell cat _header.html)
all: html
-html: olang.texi introduction.texi installation.texi getting-started.texi contribution-guide.texi
+html: olang.texi introduction.texi installation.texi getting-started.texi specification.texi contribution-guide.texi
$(MAKEINFO) --set-customization-variable AFTER_BODY_OPEN="$(HTML_HEADER)" --css-include=../style.css -o html --html olang.texi
.PHONY: clean
--git a/docs/manual/_header.html b/docs/manual/_header.html
index de347bb..9270b9a 100644
--- a/docs/manual/_header.html
+++ b/docs/manual/_header.html
@@ -3,7 +3,6 @@
<nav>
<span>[ <a href="/">Home</a> ]</span>
<span>[ <a href="/manual/">Manual</a> ]</span>
- <span>[ <a href="/pages/language-specification.html">Specification</a> ]</span>
<span>[ <a href="https://sr.ht/~johnnyrichard/olang/sources" target="_blank">Sources ↗</a> ]</span>
<span>[ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list ↗</a> ]</span>
</nav>
diff --git a/docs/manual/olang.texi b/docs/manual/olang.texi
index 3ad28f4..eea4c29 100644
--- a/docs/manual/olang.texi
+++ b/docs/manual/olang.texi
@@ -27,6 +27,7 @@ programming language.
* Introduction::
* Installation::
* Getting Started::
+* Language Specification::
* Contribution Guide::
@end menu
@@ -36,6 +37,8 @@ programming language.
@include getting-started.texi
+@include specification.texi
+
@include contribution-guide.texi
@bye
diff --git a/docs/pages/language-specification.md b/docs/manual/specification.texi
similarity index 97%
rename from docs/pages/language-specification.md
rename to docs/manual/specification.texi
index 1a70810..e028fe9 100644
--- a/docs/pages/language-specification.md
+++ b/docs/manual/specification.texi
@@ -1,7 +1,7 @@
-% O programming language specification
+@node Specification
+@chapter Specification
-Abstract
---------
+@section Introduction
This document specifies the semantics and behavior of the O Programming
Language for compiler designers be informed how the language is designed.
@@ -9,8 +9,7 @@ Language for compiler designers be informed how the language is designed.
This specification is a DRAFT and will be the discussions drive over olang-dev
mailing list.
-Language Syntax
----------------
+@section Language Syntax
This is the O Programming Language EBNF grammar specification[^1]
@@ -20,7 +19,7 @@ This is the O Programming Language EBNF grammar specification[^1]
NOTE: This grammar spec is a DRAFT and it covers only a small portion of the
language.
-```
+@verbatim
(* Entry Point *)
<translation-unit> ::= (<ows> <external-declaration> <ows> (<end-of-statement> | <end-of-file>))*
@@ -96,4 +95,4 @@ language.
<digit> ::= #'[0-9]'
<hex-digit> ::= <digit> | #'[a-fA-F]'
<end-of-file> ::= #'$'
-```
+@end verbatim
diff --git a/docs/template.html b/docs/template.html
index 232ec59..c39ca05 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -13,7 +13,6 @@
<nav>
<span>[ <a href="/">Home</a> ]</span>
<span>[ <a href="/manual/">Manual</a> ]</span>
- <span>[ <a href="/pages/language-specification.html">Specification</a> ]</span>
<span>[ <a href="https://sr.ht/~johnnyrichard/olang/sources" target="_blank">Sources ↗</a> ]</span>
<span>[ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list ↗</a> ]</span>
</nav>
--
2.46.0
next prev parent reply other threads:[~2024-09-16 14:30 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-16 16:29 [PATCH olang v1 0/3] docs: remove pandoc dependency Johnny Richard
2024-09-16 14:32 ` Carlos Maniero
2024-09-16 16:29 ` Johnny Richard [this message]
2024-09-16 16:29 ` [PATCH olang v1 2/3] docs: stop using pandoc to generate page on website Johnny Richard
2024-09-16 16:29 ` [PATCH olang v1 3/3] docs: remove pandoc dependency for man docs Johnny Richard
2024-09-16 14:31 ` [olang/patches/.build.yml] build success builds.sr.ht
2024-09-16 16:37 ` [PATCH olang v1 0/3] docs: remove pandoc dependency Johnny Richard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240916163004.43389-2-johnny@johnnyrichard.com \
--to=johnny@johnnyrichard.com \
--cc=~johnnyrichard/olang-devel@lists.sr.ht \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.johnnyrichard.com/olang.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox