Chore refactor makefile to reduce repetition #211

ghost · 2018-08-14T07:21:01Z

new pull request due to wrong branch name, and comments in #199 ( particulary #199; #pullrequestreview-144854386 ). Solves issues found in previous PR as: separate commits, separate PR, chore in branch name, phony target and static pattern rules

docker rmi deduplicated
static pattern rules introduced
%-rmi is a phony target

Resolves: #193

cameel

Looks fine overall but there are a few cosmetic issues and not all phony targets are declared as .PHONY.

BTW, if you've created a new pull request you should close #199 (and drop a comment saying that it has been superseded by a new pull request).

cameel · 2018-08-14T14:54:01Z

containers/Makefile

-verifier-clean:
-	docker rmi $(IMAGE_PREFIX)verifier:$(IMAGE_VERSION) --force
+%-rmi:
+		docker rmi $(IMAGE_PREFIX)$*:$(IMAGE_VERSION) --force


Why two tabs?

cameel · 2018-08-14T14:57:13Z

containers/Makefile

@@ -95,6 +95,7 @@ $(IMAGE_TARGETS): %: %!dependencies build/

 docker-clean: nginx-proxy-rmi nginx-storage-rmi postgresql-rmi concent-api-rmi verifier-rmi

+.PHONY: %-rmi
 %-rmi:


Please put it at the bottom of the file with all the other .PHONY targets.

cameel · 2018-08-14T14:58:14Z

containers/Makefile

-
-verifier-clean:
-	docker rmi $(IMAGE_PREFIX)verifier:$(IMAGE_VERSION) --force
+%-rmi:


You'e renaming the targets here but the old names are still listed at the bottom of the file where they're declared .PHONY.

old .PHONY targets removed

cameel · 2018-08-14T14:58:24Z

containers/Makefile

+		$(VERIFIER_SOURCE) 																\
+		build/repositories/golem/ 												\
+		build/verifier/golem/scripts/ 										\
+		build/verifier/golem/imgverifier-requirements.txt


Why two tabs?

most of the file lines uses 4 spaces as indent (55 occurences), some one tab (52 occurences) some two tabs (29 occurences) and some two spaces (3 occurences). I used two tabs as in mine editor tab=two spaces. To make it consistent, I propose to change every indent to one tab.

Have you seen #211 (comment)?

yes, replied and fixed

cameel · 2018-08-14T15:34:33Z

containers/Makefile

+verifier!dependencies:																\
+		$(VERIFIER_SOURCE) 																\
+		build/repositories/golem/ 												\
+		build/verifier/golem/scripts/ 										\


Please fix the whitespace here.

You're inserting tabs everywhere. Even inside the text (e.g. build/verifier/golem and \). We're using spaces everywhere, please use them too. Otherwise the code looks very misaligned.

The only place where we use tabs is at the beginning of a line containing a bash command in a target. And that's only because make syntax requires it.

It's fine to add a little whitespace before \ but this is way too much. There's so much that I have to scroll the diff horizontally to see that there's \ at the end of some lines.

\ should all be either in the same column (preferred) or immediately after the text.

I have just realized that we don't have this written down in our style yet so I have added a new proposal. Please see Code-Poets/coding-style#16

yeah, the problem is with different rendering engine in github and atom, apparently tabs in atom does not have fixed length, and slashes appeared to be alligned, definetely within screen width

excessive tabs replaced with spaces

…h spaces.

cameel

Still some cosmetic changes needed.

Also, please squash the commits related to .PHONY targets into one. It's actually a missing part of the commit that removed those targets, not an independent change.

cameel · 2018-08-17T12:17:22Z

containers/Makefile

+	  "build/repositories/concent/"                \
+	  "$(abspath package-builder)"                 \
+	  "$(abspath build)"                           \
+	  "$(dir $@)"


You have replaced all indents with 2-space ones. As you can see from the diff, we're already using 4-space indents. Changing it in the middle of an unrelated pull request is a bad idea.

Please keep the original indentation. Just fix the code you have added.

I've updated the issue about coding style to make it clear that we're using 4-space indents.

cameel · 2018-08-17T12:28:40Z

containers/Makefile

-		"$(abspath build)"                            \
-		"$(dir $@)"
+	build/package-builder/build-concent-api-docs.sh\
+	  "build/repositories/concent/"                \


It's a good practice to always leave a space before \. Otherwise it's easy to run into problems like this:

cat\ a.txt\ b.txt\ c.txt

bash: cata.txtb.txtc.txt: command not found

That's because bash does not add spaces on its own and sees your command as cata.txtb.txtc.txt rather than cat a.txt b.txt c.txt.

There is some whitespace at the beginning of the line in this case which would prevent this problem but that's not always the case so, as a rule, we always add at least one space at the end.

I've updated the issue for updating coding style to make it clear.

Yes, this is good remark. I added space before each "".

cameel · 2018-08-17T12:30:48Z

containers/Makefile

+	verifier      verifier-clean     \
+	docker-clean                     \
+	clean                            \
+	%-rmi


Are you sure this works? I think that pattern rules will only work if % is in the target as well. But I may be wrong. Please check.

That is correct, I did some tests and .PHONY targets must be declared explicitly.

cameel · 2018-08-17T12:33:25Z

containers/Makefile

 		--output "$@"

-


Please avoid unnecessary changes, like removing these empty lines.

I'm not saying that removing them is a bad idea but I don't want you and @bartoszbetka to get into a loop where you remove them and he adds them back :)

When editing an existing file please adapt to the style already used in it unless the issue is specifically about refactoring the style.

It was the only one occurrence of two empty lines in a row, so it looked more than correcting a mistake than imposing own coding style. Fully agree about adapting to existing style.

cameel · 2018-08-17T12:34:57Z

containers/Makefile

-		"$(abspath package-builder)"                   \
-		"$(abspath build)"                             \
-		"$(dir $@)"
+	  "build/repositories/concent/"                  \


I'm not sure if having a mix of tabs and spaces at the beginning of a line is a good idea.

according to coding style, I used tab where is needed by makefile syntax, and space everywhere else (shell arguments)

cameel · 2018-09-07T15:32:22Z

Could you look at the diff and ensure that there are no unnecessary trivial whitespace changes?

michalpiasecki1 added 3 commits August 13, 2018 15:48

docker rmi deduplicated

5867d34

static pattern rules introduced

75f6575

%-rmi is a phony target now

e6ddd00

ghost requested review from cameel and bartoszbetka August 14, 2018 07:21

cameel suggested changes Aug 14, 2018

View reviewed changes

ghost mentioned this pull request Aug 16, 2018

build dir as order only prerequisite, docker rmi deduplicated, docker… #199

Closed

michalpiasecki1 added 4 commits August 17, 2018 11:04

.PHONY targets consolidated. tabs at the end of the line replaced wit…

82739dc

…h spaces.

tabs in variables replaced with two spaces

c8483f8

second tab in target definition replaced with two spaces

ee8d2a3

old .PHONY targets removed

5fb4554

cameel suggested changes Aug 17, 2018

View reviewed changes

michalpiasecki1 added 3 commits August 21, 2018 14:11

.PHONY declared explicitly

fe165cc

added space before each "\"

1b3cffb

two space idents replaced with four space idents

f202863

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore refactor makefile to reduce repetition #211

Chore refactor makefile to reduce repetition #211

ghost commented Aug 14, 2018

cameel left a comment

cameel Aug 14, 2018

ghost Aug 17, 2018

cameel Aug 14, 2018

ghost Aug 17, 2018

cameel Aug 14, 2018

ghost Aug 17, 2018

cameel Aug 14, 2018

ghost Aug 16, 2018 •

edited by ghost

Loading

cameel Aug 16, 2018

ghost Aug 17, 2018

cameel Aug 14, 2018

ghost Aug 17, 2018

ghost Aug 17, 2018

cameel left a comment

cameel Aug 17, 2018 •

edited

Loading

cameel Aug 17, 2018

ghost Aug 21, 2018

cameel Aug 17, 2018

ghost Aug 21, 2018

cameel Aug 17, 2018

ghost Aug 17, 2018

cameel Aug 17, 2018

ghost Aug 21, 2018

cameel commented Sep 7, 2018

Chore refactor makefile to reduce repetition #211

Are you sure you want to change the base?

Chore refactor makefile to reduce repetition #211

Conversation

ghost commented Aug 14, 2018

cameel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost Aug 16, 2018 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cameel left a comment

Choose a reason for hiding this comment

cameel Aug 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cameel commented Sep 7, 2018

ghost Aug 16, 2018 •

edited by ghost

Loading

cameel Aug 17, 2018 •

edited

Loading