From b0cc5af474fae6c1786464924981fc0bf895792f Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Sun, 15 Dec 2019 00:00:26 +0300 Subject: [PATCH] Parametrized version in documentation --- download.texi | 46 ++++++++++++++++++++++++---------------------- www.mk | 4 ++-- www.texi | 2 ++ 3 files changed, 28 insertions(+), 24 deletions(-) diff --git a/download.texi b/download.texi index 47e723f..df68b9d 100644 --- a/download.texi +++ b/download.texi @@ -4,22 +4,22 @@ Preferable way is to download tarball with the signature from website and, for example, run tests with benchmarks: -@verbatim -$ [fetch|wget] http://gogost.cypherpunks.ru/gogost-4.2.0.tar.xz -$ [fetch|wget] http://gogost.cypherpunks.ru/gogost-4.2.0.tar.xz.sig -$ gpg --verify gogost-4.2.0.tar.xz.sig gogost-4.2.0.tar.xz -$ xz -d < gogost-4.2.0.tar.xz | tar xf - -$ make -C gogost-4.2.0 all bench -$ echo hello world | ./gogost-4.2.0/streebog256 +@example +$ [fetch|wget] http://gogost.cypherpunks.ru/gogost-@value{VERSION}.tar.xz +$ [fetch|wget] http://gogost.cypherpunks.ru/gogost-@value{VERSION}.tar.xz.sig +$ gpg --verify gogost-@value{VERSION}.tar.xz.sig gogost-@value{VERSION}.tar.xz +$ xz -d < gogost-@value{VERSION}.tar.xz | tar xf - +$ make -C gogost-@value{VERSION} all bench +$ echo hello world | gogost-@value{VERSION}/streebog256 f72018189a5cfb803dbe1f2149cf554c40093d8e7f81c21e08ac5bcd09d9934d -@end verbatim +@end example And then you can include its source code in your project for example like this: -@verbatim +@example $ mkdir -p myproj/src -$ cp -r gogost-4.2.0/src/go.cypherpunks.ru myproj/src +$ cp -r gogost-@value{VERSION}/src/go.cypherpunks.ru myproj/src $ export GOPATH=$PWD/myproj $ cd myproj/src $ cat > main.go < @item @url{https://lists.cypherpunks.ru/mailman/listinfo/gost, gost} maillist @item -@verbatim +@example $ gpg --auto-key-locate dane --locate-keys gogost at cypherpunks dot ru $ gpg --auto-key-locate wkd --locate-keys gogost at cypherpunks dot ru -@end verbatim +@end example @item @verbatiminclude PUBKEY.asc @@ -114,9 +114,10 @@ $ gpg --auto-key-locate wkd --locate-keys gogost at cypherpunks dot ru GoGOST is also @command{go get}-able. For example to use @command{streebog256} utility: -@verbatim + +@example $ go get go.cypherpunks.ru/gogost/cmd/streebog256 -@end verbatim +@end example @code{go.cypherpunks.ru} uses @url{https://www.cacert.org/, CACert.org} certificate authority, that is not included by default in some operating @@ -127,10 +128,11 @@ can disable their usage with @env{GOPRIVATE=go.cypherpunks.ru/gogost} environment variable. Also you can use @code{replace} feature inside your @file{go.mod}, like: -@verbatim -require go.cypherpunks.ru/gogost/v4 v4.2.0 -replace go.cypherpunks.ru/gogost/v4 => /home/stargrave/gogost-4.2.0/src/go.cypherpunks.ru/gogost/v4 -@end verbatim + +@example +require go.cypherpunks.ru/gogost/v4 v@value{VERSION} +replace go.cypherpunks.ru/gogost/v4 => /home/stargrave/gogost-@value{VERSION}/src/go.cypherpunks.ru/gogost/v4 +@end example You can obtain development source code with @command{git clone git://git.cypherpunks.ru/gogost.git}. diff --git a/www.mk b/www.mk index 0670ffd..076465a 100644 --- a/www.mk +++ b/www.mk @@ -1,9 +1,9 @@ -all: gogost.html - MAKEINFO ?= makeinfo CSS != cat style.css +all: gogost.html + gogost.html: *.texi rm -f gogost.html/*.html $(MAKEINFO) --html \ diff --git a/www.texi b/www.texi index 9b54046..8ab786a 100644 --- a/www.texi +++ b/www.texi @@ -2,6 +2,8 @@ @documentencoding UTF-8 @settitle GoGOST +@set VERSION 4.2.0 + @copying Copyright @copyright{} 2015-2019 @email{stargrave@@stargrave.org, Sergey Matveev} @end copying -- 2.44.0