public inbox for ~johnnyrichard/olang-devel@lists.sr.ht
 help / color / mirror / code / Atom feed
From: Johnny Richard <johnny@johnnyrichard.com>
To: ~johnnyrichard/olang-devel@lists.sr.ht
Cc: Johnny Richard <johnny@johnnyrichard.com>
Subject: [PATCH olang v2 1/3] olc: rename 'olang' binary to 'olc'
Date: Sun, 22 Sep 2024 17:15:54 +0200	[thread overview]
Message-ID: <20240922152119.1214443-2-johnny@johnnyrichard.com> (raw)
In-Reply-To: <20240922152119.1214443-1-johnny@johnnyrichard.com>

In the future we might need more binaries to our toolchain, by now we
want to delimit the scope of this binary to only handle compilation
related jobs.

Fun fact, the name 'olc' can be interpreted as an abbreviation for ".ol
compiler".

Signed-off-by: Johnny Richard <johnny@johnnyrichard.com>
---
 .gitignore                        |  2 +-
 Makefile                          | 14 +++++++-------
 docs/info/contribution-guide.texi |  5 ++---
 docs/info/installation.texi       |  4 ++--
 docs/man/man1/{olang.1 => olc.1}  | 10 +++++-----
 tests/integration/test.sh         |  2 +-
 6 files changed, 18 insertions(+), 19 deletions(-)
 rename docs/man/man1/{olang.1 => olc.1} (87%)

diff --git a/.gitignore b/.gitignore
index 0fe0790..f18560c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
-olang
+/olc
 build
 *.o
 *.info
diff --git a/Makefile b/Makefile
index 12b09a4..0603526 100644
--- a/Makefile
+++ b/Makefile
@@ -6,7 +6,7 @@ CFLAGS := ${CFLAGS}
 CFLAGS += -Werror -Wall -Wextra -Wmissing-declarations
 CFLAGS += -pedantic -std=c11 -ggdb
 
-TARGET := olang
+TARGET := olc
 
 PREFIX ?= /usr/local
 
@@ -41,9 +41,9 @@ install-bin: $(TARGET)
 install-man: install-man1
 
 .PHONY: install-man1
-install-man1: docs/man/man1/olang.1
-	install -Dm 644 docs/man/man1/olang.1 ${DESTDIR}${MAN1DIR}/olang.1
-	gzip -f ${DESTDIR}${MAN1DIR}/olang.1
+install-man1: docs/man/man1/olc.1
+	install -Dm 644 docs/man/man1/olc.1 ${DESTDIR}${MAN1DIR}/olc.1
+	gzip -f ${DESTDIR}${MAN1DIR}/olc.1
 
 .PHONY: install-info
 install-info: olang.info
@@ -56,15 +56,15 @@ install-info: olang.info
 uninstall: uninstall-bin uninstall-man uninstall-info
 
 .PHONY: uninstall-bin
-uninstall-bin: ${DESTDIR}${BINDIR}/olang
-	@rm -f ${DESTDIR}${BINDIR}/olang
+uninstall-bin: ${DESTDIR}${BINDIR}/$(TARGET)
+	@rm -f ${DESTDIR}${BINDIR}/$(TARGET)
 
 .PHONY: uninstall-man
 uninstall-man: uninstall-man1
 
 .PHONY: uninstall-man1
 uninstall-man1:
-	@rm -f ${DESTDIR}${MAN1DIR}/olang.1.gz
+	@rm -f ${DESTDIR}${MAN1DIR}/olc.1.gz
 
 .PHONY: uninstall-info
 uninstall-info:
diff --git a/docs/info/contribution-guide.texi b/docs/info/contribution-guide.texi
index 856d0f6..3d12048 100644
--- a/docs/info/contribution-guide.texi
+++ b/docs/info/contribution-guide.texi
@@ -22,7 +22,7 @@ merely three dependencies: @code{make}, @code{gcc} (version 11 or higher), and
 $ make
 @end example
 
-If everything went well with the compilation, you should find a @code{olang}
+If everything went well with the compilation, you should find a @code{olc}
 binary on the project root folder.
 
 As an optional step, you can install @code{texinfo}, @code{pandoc} and
@@ -32,7 +32,7 @@ read @ref{Writing Documentation}.
 @subsection Testing
 
 There are two layers of tests @strong{integration} and @strong{unit}. The
-integration test is going to execute the @code{olang} compiler and check if the
+integration test is going to execute the @code{olc} compiler and check if the
 generated binary acts as expected. Unit tests will test C functions.
 
 To run all tests you can execute:
@@ -53,7 +53,6 @@ the format section below for guidance on its application.
 @subsection Code Formatting
 
 Checking for format issues:
-
 @example
 $ make format
 @end example
diff --git a/docs/info/installation.texi b/docs/info/installation.texi
index d61b0e9..6ee4a4d 100644
--- a/docs/info/installation.texi
+++ b/docs/info/installation.texi
@@ -4,8 +4,8 @@
 This installation assumes you are running an unix like operation system and
 requires @code{make}, @code{makeinfo} and a @strong{c compiler} installed.
 
-The following commands will compile the the code and install @code{olang}
-binary, @code{man} pages and @code{info} docs into your system.
+The following commands will compile the the code and install @code{olc} binary
+(olang compiler), @code{man} pages and @code{info} docs into your system.
 
 @verbatim
 $ make
diff --git a/docs/man/man1/olang.1 b/docs/man/man1/olc.1
similarity index 87%
rename from docs/man/man1/olang.1
rename to docs/man/man1/olc.1
index fa6544f..5b35f05 100644
--- a/docs/man/man1/olang.1
+++ b/docs/man/man1/olc.1
@@ -1,21 +1,21 @@
-.\" Man page for olang
+.\" Man page for olc
 .\" Contact ~johnnyrichard/olang-devel@lists.sr.ht to report issues
 
-.TH man 1 "Feb 2024" "0.0" "olang man page"
+.TH man 1 "Feb 2024" "0.0" "olc man page"
 
 .SH NAME
 
-olang \- O programming language compiler
+olc \- olang compiler
 
 .SH SYNOPSIS
 
-olang source_file
+olc source_file
 
 [ --dump-tokens ] [ --dump-ast ] [ [ -o output_file [ --save-temps ] [ --arch arch ]  [ --sysroot dir] ]
 
 .SH DESCRIPTION
 
-.B olang
+.B olc
 is the official O programming language compiler, it is also a tool that contains
 utilities to help the language development.
 
diff --git a/tests/integration/test.sh b/tests/integration/test.sh
index 69cbeda..529f0f5 100755
--- a/tests/integration/test.sh
+++ b/tests/integration/test.sh
@@ -16,7 +16,7 @@
 
 # Ignores variables been modified in a subshell
 # shellcheck disable=SC2030,SC2031
-OLANG_PATH="../../olang"
+OLANG_PATH="../../olc"
 TEST_FILE="$1"
 
 TEST_TMP_FILES="$TEST_FILE.test"
-- 
2.46.0


  reply	other threads:[~2024-09-22 15:21 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-22 15:15 [PATCH olang v2 0/3] improve test's makes and compiler binary Johnny Richard
2024-09-22 15:15 ` Johnny Richard [this message]
2024-09-22 15:15 ` [PATCH olang v2 2/3] tests: build: enhance compiler tests Johnny Richard
2024-09-22 15:15 ` [PATCH olang v2 3/3] tests: build: add parallelization support for unit tests Johnny Richard
2024-09-23  9:09 ` [PATCH olang v2 0/3] improve test's makes and compiler binary Carlos Maniero
2024-09-23 10:57   ` 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=20240922152119.1214443-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