From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id 1esMJg5B6GZ6UwAAe85BDQ:P1 (envelope-from ) for ; Mon, 16 Sep 2024 16:30:38 +0200 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id 1esMJg5B6GZ6UwAAe85BDQ (envelope-from ) for ; Mon, 16 Sep 2024 16:30:38 +0200 X-Envelope-To: patches@johnnyrichard.com Authentication-Results: aspmx1.migadu.com; none Received: from mail-a.sr.ht (mail-a.sr.ht [46.23.81.152]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 8AC4B1D488 for ; Mon, 16 Sep 2024 16:30:35 +0200 (CEST) DKIM-Signature: a=rsa-sha256; bh=BI2SFGFj7Ik4ek0joUCf2yANjL6YJvb8Jt1YykSbXMw=; c=simple/simple; d=lists.sr.ht; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-Unsubscribe:List-Subscribe:List-Archive:List-Post:List-ID; q=dns/txt; s=20240113; t=1726497034; v=1; b=kbvzJ1qVJ4G802V4WGLjaAs2uTjMRnxCGa6RTY8PxxmtnAuiZe2Rfp0cWRWoJgLnYDeLcvee eP+xQ9RogIUF/RF+/NnUSEeJCEfHpn2gCysVu7G51OS6c7n8QuucZxwcri/zvkOmG+uaY7ifm9b MBBo/viZE9Z2urrLjD3AQ5tBxvawtgbwKXC5dFKz/3lcGjNOpy4mFqpq/DBqE2BYQ8NV6RsE1xP RhmtmwjNn8TxaCs0PwZvdEJIODAk65MFYYTnlWv30++HwfdxnkMiZsafJZwupHSjqpeIFxlBFrE awrZawomaDpLzYmwNh5pySKLbmRyQe7jh2Wf6V4JjMTqA== Received: from lists.sr.ht (unknown [46.23.81.154]) by mail-a.sr.ht (Postfix) with ESMTPSA id DF05220285 for ; Mon, 16 Sep 2024 14:30:34 +0000 (UTC) Received: from out-179.mta0.migadu.com (out-179.mta0.migadu.com [91.218.175.179]) by mail-a.sr.ht (Postfix) with ESMTPS id 102862026F for <~johnnyrichard/olang-devel@lists.sr.ht>; Mon, 16 Sep 2024 14:30:34 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=johnnyrichard.com; s=key1; t=1726497033; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=MMOhlHPUknbK/zUo6qBpqaU9vXhJwn1B/1qGiKb3xV4=; b=YRstauI3T2cCfIs8uXNpypvL/+5L5kBiXxBkwqzFr3MzsAjEkJfVGzsKOBQBIcBJqGYPQs TS2oP6hczsFiiAf8RClmuS5lkdIBnk7fRWS4M8xs9ydA1Z14HDB4whvdqVO/+WP8hb6/Qo DThoa6vAce4K0/m6n5dlpoY2zVQ5BHY8s2Ibw6O5VWmdlE9KKfNbByKDTL9BRQpNqQxUqa h/3snIPTvGqrN1KSsY1aVqpTatGNCuu8Yf3VVxFfw+1feFFF4CH0yPSp9orPE+M7fvIpq0 dDES1MJTVbj4zrmXeIzVkRVwRClZcy4JQ6TxMesGPhpX8mJAfMJMpBlWUJjCNg== From: Johnny Richard To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Johnny Richard Subject: [PATCH olang v1 1/3] docs: move language spec to manual document Date: Mon, 16 Sep 2024 18:29:12 +0200 Message-ID: <20240916163004.43389-2-johnny@johnnyrichard.com> In-Reply-To: <20240916163004.43389-1-johnny@johnnyrichard.com> References: <20240916163004.43389-1-johnny@johnnyrichard.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Sourcehut-Patchset-Status: UNKNOWN List-Unsubscribe: List-Subscribe: List-Archive: Archived-At: List-Post: List-ID: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel.lists.sr.ht> Sender: ~johnnyrichard/olang-devel <~johnnyrichard/olang-devel@lists.sr.ht> X-Migadu-Flow: FLOW_IN X-Migadu-Country: NL X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -4.00 X-Migadu-Queue-Id: 8AC4B1D488 X-Spam-Score: -4.00 X-TUID: L5Ns77n6ha41 Signed-off-by: Johnny Richard --- docs/manual/Makefile | 2 +- docs/manual/_header.html | 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 diff --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 @@ 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 *) ::= ( ( | ))* @@ -96,4 +95,4 @@ language. ::= #'[0-9]' ::= | #'[a-fA-F]' ::= #'$' -``` +@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 @@ -- 2.46.0