yamake 0.1.11

yet another make tool.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

.PHONY: run build doc png test1 test2 tests help json json-errors runPdf doc-serve \
demo-cluster reinstall-mdbook run_1 run_2 run_3 run_4 demo-expand show-report clean
.DEFAULT: help


include scripts/colorprint

sandbox:=sandbox
srcdir:=demo_projects
my_C_tool:=yamake/target/debug/examples/c_project_demo
expand_demo:=yamake/target/debug/examples/expand_demo
my_Pdf_tool:=yamake/target/debug/examples/Latex_demo_project


help: ## Show this help message
	@echo "Available commands:"
# 	echo $(MAKEFILE_LIST)
#	was $(MAKEFILE_LIST) but fails if there is an include. So we use Makefile
	@grep -E '^[ a-zA-Z_0-9-]+:.*?## .*$$' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "$(Red)%-20s$(Color_Off) : $(Blue)%s$(Color_Off)\n", $$1, $$2}'

run_1: build ## demo : use our demo C tool, to compile our demo C project
## ANCHOR: run_1
	@rm -rf $(sandbox)
	@mkdir -p $(sandbox)
	@git checkout HEAD -- demo_projects
	@printf "\n$(White)$(On_Blue)run yamake tool to build the C program$(Color_Off)\n"
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)run the compiled program$(Color_Off)\n"
	@./$(sandbox)/project_C/demo
	@printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n"
	@cp $(sandbox)/make-report.json doc/src/make-reports/run_1.json
## ANCHOR_END: run_1

run_2: build ## demo : build, delete an artefact, build again
## ANCHOR: run_2
	@rm -rf $(sandbox)
	@mkdir -p $(sandbox)
	@git checkout HEAD -- demo_projects
	@printf "\n$(White)$(On_Blue)run yamake tool to build the C program$(Color_Off)\n"
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)delete add.o, build again$(Color_Off)\n"
	rm $(sandbox)/project_C/add.o
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n"
	@cp $(sandbox)/make-report.json doc/src/make-reports/run_2.json
## ANCHOR_END: run_2

run_3: build ## demo : make a change in the source, that has no effect (eg, add a comment)
## ANCHOR: run_3
	@rm -rf $(sandbox)
	@mkdir -p $(sandbox)
	@git checkout HEAD -- demo_projects
	@printf "\n$(White)$(On_Blue)run yamake tool to build the C program$(Color_Off)\n"
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)add a comment$(Color_Off)\n"
	echo "// a C comment " >> $(srcdir)/project_C/add.c
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n"
	@cp $(sandbox)/make-report.json doc/src/make-reports/run_3.json
## ANCHOR_END: run_3

run_4: build ## demo : make a change in the source, that is an coding error
## ANCHOR: run_4
	@rm -rf $(sandbox)
	@mkdir -p $(sandbox)
	@git checkout HEAD -- demo_projects
	@printf "\n$(White)$(On_Blue)run yamake tool to build the C program$(Color_Off)\n"
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)add a comment$(Color_Off)\n"
	echo "blah blah " >> $(srcdir)/project_C/add.c
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n"
	@cp $(sandbox)/make-report.json doc/src/make-reports/run_4.json
## ANCHOR_END: run_4

run : build ## use our demo C tool, to compile our demo C project
	@mkdir -p $(sandbox)
	@printf "\n$(White)$(On_Blue)run yamake tool to build the C program$(Color_Off)\n"
	$(my_C_tool) $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)run the compiled program$(Color_Off)\n"
	./$(sandbox)/project_C/demo
	@printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n"

runPdf : build ## use our demo Latex tool, to compile our demo Latex to Pdf
	@mkdir -p $(sandbox)
	@printf "\n$(White)$(On_Blue)run yamake tool to build the Pdf doc generator$(Color_Off)\n"
	$(my_Pdf_tool) --nb-workers 1 $(srcdir) $(sandbox)
	@printf "\n$(White)$(On_Blue)run the tool to build the pdf$(Color_Off)\n"
	ls -l $(sandbox)/project_latex/*.pdf
	@printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n"

test1 : build
	$(my_C_tool) $(srcdir) $(sandbox) && \
	rm $(sandbox)/project_C/demo && \
	$(my_C_tool) $(srcdir) $(sandbox) && \
	ls $(sandbox)/project_C/demo

test2 : build
	$(my_C_tool) $(srcdir) $(sandbox) && \
	rm $(sandbox)/project_C/main.o && \
	$(my_C_tool) $(srcdir) $(sandbox) && \
	ls $(sandbox)/project_C/demo

test_pdf : build


test: build
	echo "" > yamake.log
	cargo fmt && cargo test ${args}

png : run
	@printf "$(Blue)when running$(Color_Off) $(Red)our demo tool$(Color_Off)$(Blue), dot files of the build graph are generated$(Color_Off) => use graphviz to get png files\n"
	dot -Tpng -o $(sandbox)/before-scan.png $(sandbox)/before-scan.dot
	dot -Tpng -o $(sandbox)/after-scan.png  $(sandbox)/after-scan.dot
	cp $(sandbox)/*scan.png doc/src/howto/.

build: ## build our demo tool, written in rust, using yamake. This demo tool is a builder for our demo project, a C project in $(srcdir) directory
	@printf "\n$(White)$(On_Blue)build the demo$(Color_Off)\n"
	( cargo fmt && 	cargo build --examples  )
	@printf "finished building\n"

clean:
	rm -rf $(sandbox)
	mkdir $(sandbox)

show-report: ## inspect the json result
	jq ".items[] | { target:.target,status:.status}" $(sandbox)/make-report.json

# ANCHOR: json-errors
show-errors: ## use make-report.json to find errors and print relevant logs
	@printf "\n$(White)$(On_Blue)use make-report.json to find error and print relevant logs$(Color_Off)\n"
	@sandbox=$(shell jq '.sandbox ' $(sandbox)/make-report.json) ;\
	srcdir=$(shell jq '.srcdir ' $(sandbox)/make-report.json) ;\
	stdoutfiles=$(shell jq '.items[] | select(.status == "Failed") | .stdout ' $(sandbox)/make-report.json) ; \
	stderrfiles=$(shell jq '.items[] | select(.status == "Failed") | .stderr ' $(sandbox)/make-report.json) ; \
	for f in $$stdoutfiles ; do \
		echo "----------- stdout " ; \
		echo "ERROR while building target ${Red}$$f${Color_Off}" ; \
		echo "----------- " ; \
		cat $$sandbox/$$f | sed "s#$$sandbox#$$srcdir#g" ; \
		echo "----------- end stdout" ; \
	done ; \
	for f in $$stderrfiles ; do \
		echo "----------- stderr " ; \
		echo "ERROR while building target ${Red}$$f${Color_Off}" ; \
		echo "----------- " ; \
		cat $$sandbox/$$f | sed "s#$$sandbox#$$srcdir#g" ; \
		echo "----------- end stderr" ; \
	done ; \
	echo "\n$(White)$(On_Blue)end show-errors$(Color_Off)\n"

# ANCHOR_END: json-errors


reinstall-mdbook: ## reinstall mdbook
	cargo install mdbook@0.5.2 --force
	cargo install mdbook-mermaid --force
	cargo install mdbook-admonish --force
	cargo install mdbook-toc --force

doc-serve: ## run mdbook and serve
	cd doc && mdbook serve


demo-expand: build ## demo : demo for a cluster of generated files
	@rm -rf $(sandbox)
	@mkdir -p $(sandbox)
	@git checkout HEAD -- demo_projects
	@printf "\n$(White)$(On_Blue)run the builder$(Color_Off)\n" && \
	$(expand_demo) $(srcdir) $(sandbox) && \
	printf "\n$(White)$(On_Blue)run the builded demo program$(Color_Off)\n" && \
	./$(sandbox)/demo_expand/demo && \
	printf "\n$(White)$(On_Blue)end of run$(Color_Off)\n" && \
	cp $(sandbox)/make-report.json doc/src/make-reports/run_1.json