From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id YFE/GQ9B6GY5dwAA62LTzQ:P1 (envelope-from ) for ; Mon, 16 Sep 2024 16:30:39 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id YFE/GQ9B6GY5dwAA62LTzQ (envelope-from ) for ; Mon, 16 Sep 2024 16:30:39 +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 4E4D784462 for ; Mon, 16 Sep 2024 16:30:36 +0200 (CEST) DKIM-Signature: a=rsa-sha256; bh=Nelr6Zzq8rF/xNtMezk0jk/SfWgzJ8EVIDl/nKB63Y8=; 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=1726497035; v=1; b=Zu+IknXJk3WrAUMoeOypVGhzwdA1BftE1AVWeZRODHC2n9Y7k5tfG8D9IRAPbqWg0zeWCnEy zd8IPNNJhaJlSn+vkRiGemEMn0oLTpdCe9t2jH6twkyZ/YzuEfqVS00LtIIEtDjbP1zT3HdjGl1 mgpq9T/Nn2Stb3T88QCMRyvTq3uRAYp21meJgZZd2LdDa4jcH/BhWzDtVtGAwDUjm4sqd12xREn XvTQorWp8MynxkkTjzat0t9poUYJOWKedIgwK557rujNroIwoy5shsn+Z2QJhg1LnJSaKd9mY+5 y3bjnaAYmSalq7X/+v5x6MDvkJWkeU/+wbAwhYwqoeRRA== Received: from lists.sr.ht (unknown [46.23.81.154]) by mail-a.sr.ht (Postfix) with ESMTPSA id C6E7B20287 for ; Mon, 16 Sep 2024 14:30:35 +0000 (UTC) Received: from out-188.mta0.migadu.com (out-188.mta0.migadu.com [91.218.175.188]) by mail-a.sr.ht (Postfix) with ESMTPS id 517FB2026F 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=1726497034; 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=oRlsOqh2hf67eOgMhiwPolGkJNOQ2CZWpu6DPryRQ64=; b=u37BDP7UQ/iJ200tMXA8MNqSYslQyqIhjZFW+o8oh6kHfpjLD0yu8lqC1xOjBM78/St4Tb zUQT8tlF/H6VQTy7tGu2Ud1TGrjJwGx6cCykq4QXRpeyL2LQ9SKrrtHftIx7U1sjPmPn2p 1Zvq59yJM0m8D50IYSFKruAiZjA6LFeu6cOff6j67fUpQvFjPenA+Ffj9JOTMUnAwxlF04 5PbxaPQoY93eQL9qVjlnj2DMAyUlI3ETcobnjLZ73jer20dn1jFXOlWElSuJbtUZVCUVUY 2IJsLLfZ3lLiaBsTxUp2lItwwOO1mNpS7xKPXSl/HHIW0cssSnDNRfg8k9jkzw== From: Johnny Richard To: ~johnnyrichard/olang-devel@lists.sr.ht Cc: Johnny Richard Subject: [PATCH olang v1 3/3] docs: remove pandoc dependency for man docs Date: Mon, 16 Sep 2024 18:29:14 +0200 Message-ID: <20240916163004.43389-4-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: PROPOSED 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-Queue-Id: 4E4D784462 X-Migadu-Scanner: mx11.migadu.com X-Spam-Score: -4.00 X-Migadu-Spam-Score: -4.00 X-TUID: saYSdnAVErNd Pandoc is an excelente tool and works pretty well, but I think it's overkill to keep it just for create a manpage. The man pages should be pretty simple to create using the roff syntax so lets keep things simpler with less dependency. Signed-off-by: Johnny Richard --- .build.yml | 1 - docs/Makefile | 4 ++-- docs/manpages/olang.1 | 53 ++++++++++++++++++++++++++++++++++++++++++ docs/manpages/olang.md | 40 ------------------------------- 4 files changed, 55 insertions(+), 43 deletions(-) create mode 100644 docs/manpages/olang.1 delete mode 100644 docs/manpages/olang.md diff --git a/.build.yml b/.build.yml index 3cbba82..8265da2 100644 --- a/.build.yml +++ b/.build.yml @@ -5,7 +5,6 @@ packages: - make - hut - clang - - pandoc-cli - texinfo environment: site: o-lang.org diff --git a/docs/Makefile b/docs/Makefile index 3d01e0f..a38c091 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -26,8 +26,8 @@ manpages: $(BUILD_DIR) $(MANPAGES)/olang.1 manual: $(SITE_DIR)/manual/index.html -$(MANPAGES)/%.1: manpages/%.md - $(PANDOC) -s -t man $< > $@ +$(MANPAGES)/%.1: manpages/%.1 + @cp $< $@ $(DIST_FILE): all tar -czf $(DIST_FILE) -C $(SITE_DIR) . diff --git a/docs/manpages/olang.1 b/docs/manpages/olang.1 new file mode 100644 index 0000000..fed1e4e --- /dev/null +++ b/docs/manpages/olang.1 @@ -0,0 +1,53 @@ +.\" Man page for olang +.\" Contact ~johnnyrichard/olang-devel@lists.sr.ht to report issues + +.TH man 1 "Feb 2024" "0.0" "olang man page" + +.SH NAME + +olang \- O programming language compiler + +.SH SYNOPSIS + +olang source_file + +[ --dump-tokens ] [ --dump-ast ] [ [ -o output_file [ --save-temps ] [ --arch arch ] [ --sysroot dir] ] + +.SH DESCRIPTION + +.B olang +is the official O programming language compiler, it is also a tool that contains +utilities to help the language development. + +.SH OPTIONS + +.TP +.BI \-\-dump-tokens +Display lexical tokens given a soruce.ol code. + +.TP +.BR \-\-dump-ast +Display AST tree to stdout right after syntax analyzes + +.TP +.BI \-o\ file +Compile program into a binary file + +.TP +.BR \-\-save\-temps +Keep temp files used to compile program + +.TP +.BI \-\-arch\ arch + +Binary arch: default to "x86_64", avaliable options ("x86_64" | "aarch64") + +.TP +.BI \-\-sysroot\ dir + +System root dir where the GNU Assembler and GNU Linker are located: default to '/' + + +.SH AUTHOR + +Olang Maintainers <~johnnyrichard/olang-devel@lists.sr.ht> diff --git a/docs/manpages/olang.md b/docs/manpages/olang.md deleted file mode 100644 index fbca5c3..0000000 --- a/docs/manpages/olang.md +++ /dev/null @@ -1,40 +0,0 @@ -% OLANG(1) -% olang mantainers -% Feb 2024 - -# NAME - -olang - O Programming Language compiler - -# SYNOPSIS - -**olang** - source_file - [**----dump-tokens**] - [**----dump-ast**] - [**--o** ___output_file___ [**----save-temps**] [**----arch** ___arch___] [**----sysroot** ___dir___]] - -# DESCRIPTION - -**olang** is the offical O programming language compiler, it is also a tool that -contains utilities to help the language development. - -# GENERAL OPTIONS - -**----dump-tokens** -: Display lexical tokens given a soruce.0 code. - -**----dump-ast** -: Display AST tree to stdout right after syntax analyzes - -**--o** ___file___ -: Compile program into a binary file - -**----save-temps** -: Keep temp files used to compile program - -**----arch** ___architecture___ -: Binary arch: default to "x86_64", avaliable options ("x86_64" | "aarch64") - -**----sysroot** ___dir___ -: System root dir where the GNU Assembler and GNU Linker are located: default to '/' -- 2.46.0