From f9386ac5137e217ddc50deb605c2db62f16c65f8 Mon Sep 17 00:00:00 2001
From: Allan Blanchard <allan.blanchard@cea.fr>
Date: Thu, 4 Aug 2022 08:49:02 +0200
Subject: [PATCH] [doc] tgz -> tar.gz + generate hello
---
.gitignore | 4 ++--
.gitlab-ci.yml | 2 +-
bin/build-src-distrib.sh | 2 +-
doc/Makefile | 10 ++++++----
doc/aorai/Makefile | 14 +++++++-------
doc/developer/Makefile | 15 +++++++--------
doc/release/website.tex | 2 +-
nix/manuals.nix | 2 +-
8 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/.gitignore b/.gitignore
index f0eff975f0e..7b6e9634249 100644
--- a/.gitignore
+++ b/.gitignore
@@ -86,9 +86,9 @@ _build
/doc/acsl/
-/doc/aorai/aorai-example.tgz
+/doc/aorai/aorai-example.tar.gz
/doc/aorai/aorai-example/
-/doc/aorai/frama-c-aorai-example.tgz
+/doc/aorai/frama-c-aorai-example.tar.gz
/doc/aorai/frama-c-aorai-example
/doc/aorai/main.pdf
/doc/aorai/ya_file.tex
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 104357272e3..e94a20ee32b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -232,7 +232,7 @@ manuals:
artifacts:
paths:
- manuals/*.pdf
- - manuals/*.tgz
+ - manuals/*.tar.gz
- manuals/*.txt
expire_in: 7 days # Note: the LAST artifact of the ref is always kept
diff --git a/bin/build-src-distrib.sh b/bin/build-src-distrib.sh
index bb1682475f5..fbc41f1c1ab 100755
--- a/bin/build-src-distrib.sh
+++ b/bin/build-src-distrib.sh
@@ -377,7 +377,7 @@ function add_version_page {
echo " - name: Aoraï manual" >> $VERSION_WEBPAGE_PATH
echo " link: /download/aorai-manual-$FRAMAC_VERSION_AND_CODENAME.pdf" >> $VERSION_WEBPAGE_PATH
echo " help: Aoraï example" >> $VERSION_WEBPAGE_PATH
- echo " help_link: /download/aorai-example-$FRAMAC_VERSION_AND_CODENAME.tgz" >> $VERSION_WEBPAGE_PATH
+ echo " help_link: /download/aorai-example-$FRAMAC_VERSION_AND_CODENAME.tar.gz" >> $VERSION_WEBPAGE_PATH
fi
check_manual_path_MUST_ADD "metrics"
if [[ $MUST_ADD == "yes" ]]; then
diff --git a/doc/Makefile b/doc/Makefile
index 25ca4a31028..7449ebf6b50 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -85,7 +85,7 @@ endif
clean::
$(RM) manuals/*.pdf
- $(RM) manuals/*.tgz
+ $(RM) manuals/*.tar.gz
$(MAKE) -C userman clean
$(MAKE) -C developer dist-clean
$(MAKE) -C rte clean
@@ -99,7 +99,8 @@ all: \
manuals/plugin-development-guide$(FC_SUFFIX).pdf \
manuals/rte-manual$(FC_SUFFIX).pdf \
manuals/aorai-manual$(FC_SUFFIX).pdf \
- manuals/aorai-example$(FC_SUFFIX).tgz \
+ manuals/aorai-example$(FC_SUFFIX).tar.gz \
+ manuals/hello$(FC_SUFFIX).tar.gz \
manuals/eva-manual$(FC_SUFFIX).pdf \
manuals/metrics-manual$(FC_SUFFIX).pdf \
manuals/wp-manual$(FC_SUFFIX).pdf \
@@ -112,7 +113,7 @@ manuals/%:
$(PRINT) Generating $@
$(MAKE) -C $(@D) $(@F)
-%.tgz:
+%.tar.gz:
$(PRINT) Generating $@
$(MAKE) -C $(@D) $(@F)
@@ -120,7 +121,8 @@ manuals/user-manual$(FC_SUFFIX).pdf: userman/userman.pdf
manuals/plugin-development-guide$(FC_SUFFIX).pdf: developer/developer.pdf
manuals/rte-manual$(FC_SUFFIX).pdf: rte/main.pdf
manuals/aorai-manual$(FC_SUFFIX).pdf: aorai/main.pdf
-manuals/aorai-example$(FC_SUFFIX).tgz: aorai/aorai-example.tgz
+manuals/aorai-example$(FC_SUFFIX).tar.gz: aorai/aorai-example.tar.gz
+manuals/hello$(FC_SUFFIX).tar.gz: developer/hello.tar.gz
manuals/eva-manual$(FC_SUFFIX).pdf: eva/main.pdf
manuals/metrics-manual$(FC_SUFFIX).pdf: metrics/metrics.pdf
manuals/wp-manual$(FC_SUFFIX).pdf: ../src/plugins/wp/doc/manual/wp.pdf
diff --git a/doc/aorai/Makefile b/doc/aorai/Makefile
index 750c6c23f14..bb56a790d23 100644
--- a/doc/aorai/Makefile
+++ b/doc/aorai/Makefile
@@ -35,23 +35,23 @@ EXAMPLES=example.c example.ltl example.ya \
BNF=ya_file.bnf basic_ya.bnf extended_ya.bnf ya_variables.bnf
-all: main.pdf $(ARCHIVENAME).tgz
+all: main.pdf $(ARCHIVENAME).tar.gz
main.pdf: main.tex $(BNF:.bnf=.tex) macros.tex
touch main.aux #work around latexmk bug
latexmk -pdf main.tex
-$(ARCHIVENAME).tgz: $(addprefix example/, $(EXAMPLES))
+$(ARCHIVENAME).tar.gz: $(addprefix example/, $(EXAMPLES))
@rm -fr $(ARCHIVENAME)
@mkdir $(ARCHIVENAME)
@cp $^ $(ARCHIVENAME)
@tar czvf $@ $(ARCHIVENAME)
-install: main.pdf $(ARCHIVENAME).tgz
+install: main.pdf $(ARCHIVENAME).tar.gz
mkdir -p ../manuals
- @echo "copying example.tgz in ${DWNLDDIR}/$(ARCHIVENAME).tgz"
- @rm -f "${DWNLDDIR}/$(ARCHIVENAME).tgz"
- @cp $(ARCHIVENAME).tgz "${DWNLDDIR}/$(ARCHIVENAME).tgz"
+ @echo "copying example.tar.gz in ${DWNLDDIR}/$(ARCHIVENAME).tar.gz"
+ @rm -f "${DWNLDDIR}/$(ARCHIVENAME).tar.gz"
+ @cp $(ARCHIVENAME).tar.gz "${DWNLDDIR}/$(ARCHIVENAME).tar.gz"
@echo "copying main.pdf in $(DWNLDDIR)/$(DOCNAME)"
@rm -f "$(DWNLDDIR)/$(DOCNAME)"
@cp main.pdf "$(DWNLDDIR)/$(DOCNAME)"
@@ -62,7 +62,7 @@ clean:
*.cm? *.idx *.o pp.ml pp *.dvi *.blg *.bbl \
main???.png *.image.tex *.haux *.htoc *.html \
*.backup *.pdf *.backup example/frama_c_journal.ml \
- $(ARCHIVENAME) $(ARCHIVENAME).tgz
+ $(ARCHIVENAME) $(ARCHIVENAME).tar.gz
.SUFFIXES: .tex .bnf .ml .cmo .mll
diff --git a/doc/developer/Makefile b/doc/developer/Makefile
index c725a2b1424..8718ee6e1cc 100644
--- a/doc/developer/Makefile
+++ b/doc/developer/Makefile
@@ -143,20 +143,19 @@ check-viewcfg-v5:
check-viewcfg-v6:
cd tutorial/viewcfg/v2-* && $(duneb) @install
-archives: FILES=$(shell cd tutorial/hello/v7-doc && git ls-files)
+hello.tar.gz: FILES=$(shell cd tutorial/hello/v7-doc && git ls-files)
# - use 'git ls-files' to avoid including extraneous files in archive
# - use several tar options to improve build reproducibility
-archives:
- export VERSION="$(shell cat ../../VERSION)" && \
+hello.tar.gz:
cd tutorial/hello && \
- rm -rf hello-$$VERSION && \
- cp -r v7-doc hello-$$VERSION && \
- tar -cf - $(addprefix hello-$$VERSION/,$(FILES)) \
+ rm -rf hello && \
+ cp -r v7-doc hello && \
+ tar -cf - $(addprefix hello/,$(FILES)) \
--numeric-owner --owner=0 --group=0 --sort=name \
--mtime="$$(date +"%F") Z" --mode='a+rw' | \
- gzip -9 -n > ../../hello-$$VERSION.tar.gz && \
- rm -rf hello-$$VERSION
+ gzip -9 -n > ../../hello.tar.gz && \
+ rm -rf hello
###########
diff --git a/doc/release/website.tex b/doc/release/website.tex
index 7ad669583bc..8ebbbb7f7e9 100644
--- a/doc/release/website.tex
+++ b/doc/release/website.tex
@@ -70,7 +70,7 @@ them will appear:
\item \texttt{e-acsl/e-acsl-X.XX.pdf}
\item \texttt{e-acsl/e-acsl-implementation-NN.N-CODENAME.pdf}
\item \texttt{e-acsl/e-acsl-manual-NN.N-CODENAME.pdf}
- \item \texttt{aorai-example-NN.N-CODENAME.tgz}
+ \item \texttt{aorai-example-NN.N-CODENAME.tar.gz}
\item \texttt{frama-c-NN.N-CODENAME.tar.gz}
\item \texttt{frama-c-api-NN.N-CODENAME.tar.gz}
\item \texttt{hello-NN.N-CODENAME.tar.gz}
diff --git a/nix/manuals.nix b/nix/manuals.nix
index 18fc9fbb379..30bdbd93afd 100644
--- a/nix/manuals.nix
+++ b/nix/manuals.nix
@@ -49,7 +49,7 @@ stdenv.mkDerivation rec {
installPhase = ''
mkdir -p $out
cp ./doc/manuals/*.pdf $out
- cp ./doc/manuals/*.tgz $out
+ cp ./doc/manuals/*.tar.gz $out
cp ./doc/manuals/*.txt $out
'';
}
--
GitLab