From ac2ab4f719c73b2592beb4c31b32417d8ebf5a9b Mon Sep 17 00:00:00 2001 From: Konstantin Kushnir Date: Sun, 5 May 2024 10:07:25 +0000 Subject: [PATCH] Refine the build instructions --- ChangeLog | 3 ++- README.md | 5 ++++- before-release.sh | 11 ++++++++++- doc/doc.ruff | 5 ++++- doc/mtls.html | 7 +++++-- doc/mtls.n | 2 +- manifest.uuid | 2 +- 7 files changed, 27 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2f82d5c..559551e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,6 +1,7 @@ 2024-05-05 Konstantin Kushnir * Bumped version to 1.1.0 * Fix typo + * Refine the build instructions 2024-04-28 Konstantin Kushnir - * RELEASE TAG 1.0.0 \ No newline at end of file + * RELEASE TAG 1.0.0 diff --git a/README.md b/README.md index c1f27ce..2143bac 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,11 @@ building with Mingw-w64 toolchain is supported. The standard TEA config, make and install process is supported. ``` +$ git clone https://github.com/chpock/tclmtls.git $ cd tclmtls -$ ./configure +$ git submodule update --init --recursive +$ mkdir build && cd build +$ ../configure $ make $ make test $ make install diff --git a/before-release.sh b/before-release.sh index 1277368..3f9f5ac 100755 --- a/before-release.sh +++ b/before-release.sh @@ -3,7 +3,16 @@ SELF_DIR="$(dirname "$0")" VERSION="$(cat "$SELF_DIR/version")" -rm -f "$SELF_DIR/manifest.uuid" +( + cd "$SELF_DIR" + printf "git-" >"$SELF_DIR"/manifest.uuid + git rev-parse HEAD >>"$SELF_DIR"/manifest.uuid || ( + printf "svn-r" >"$SELF_DIR"/manifest.uuid + svn info --show-item last-changed-revision >>"$SELF_DIR"/manifest.uuid + ) || ( + printf "unknown" >"$SELF_DIR"/manifest.uuid + ) +) tclsh "$SELF_DIR/tools/ruff.tcl" "::Introduction ::mtls" -preeval "source $SELF_DIR/doc/doc.ruff" \ -outdir "$SELF_DIR/doc" -outfile "mtls.html" -product "mtls" -version "$VERSION" \ diff --git a/doc/doc.ruff b/doc/doc.ruff index 06c924f..45343ba 100644 --- a/doc/doc.ruff +++ b/doc/doc.ruff @@ -60,8 +60,11 @@ namespace eval Introduction { The standard TEA config, make and install process is supported. ``` + $ git clone https://github.com/chpock/tclmtls.git $ cd tclmtls - $ ./configure + $ git submodule update --init --recursive + $ mkdir build && cd build + $ ../configure $ make $ make test $ make install diff --git a/doc/mtls.html b/doc/mtls.html index dcdc18e..df4a8d2 100644 --- a/doc/mtls.html +++ b/doc/mtls.html @@ -6,7 +6,7 @@
-Mtls (v1.0.0) +Mtls (v1.1.0)
@@ -50,8 +50,11 @@

How to buildThe standard TEA config, make and install process is supported.

+$ git clone https://github.com/chpock/tclmtls.git
 $ cd tclmtls
-$ ./configure
+$ git submodule update --init --recursive
+$ mkdir build && cd build
+$ ../configure
 $ make
 $ make test
 $ make install
diff --git a/doc/mtls.n b/doc/mtls.n
index ab90cb3..316af97 100644
--- a/doc/mtls.n
+++ b/doc/mtls.n
@@ -1,6 +1,6 @@
 '\"
 '\"
-.TH "mtls" 3tcl 1\&.0\&.0 "mtls" "Mtls"
+.TH "mtls" 3tcl 1\&.1\&.0 "mtls" "Mtls"
 .SH NAME
 Introduction - Mtls
 .SH SYNOPSIS
diff --git a/manifest.uuid b/manifest.uuid
index 9c09a69..91b1d2b 100644
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-git-7770b7fe7e40c93fbe166c091c54fe3129cd6a35
+git-1624bbce7392d94a5e7099bc3365af4a94acd82a