[doc] Revise howto

[zomen2]

No description provided.

[csordasmarton]

Try to simplify this Makefile based on this Makefile: https://github.com/Ericsson/codechecker/blob/master/web/tests/projects/cpp/Makefile

[zomen2]

To start a make process from other directory is allowed. This line prevents accidentally deletions in this case by clean target.

[csordasmarton]

This Makefile is really complex and it contains a lot of unnecessary things. This is just a test project, so please keep it as simple as possible.

[zomen2]

This file is not subject of the howto document. It only works and nice.

[csordasmarton]

This is the subject of this patch. Later if someone wants to modify this file it will be hard to understand it, because it is very complex. So I still recommend to simplify this. The whole Makefile can look like this:

CFLAGS = -Iincl

all:
	$(CC) $(CFLAGS) -c src/divide.c -o /dev/null
	$(CC) $(CFLAGS) -c src/main.c -o /dev/null

[csordasmarton]

This is marked as resolved but it is not resolved yet. Please do not mark comment as resolved untill it is trully resolved or give me a reason why it is not resolved.

[dkrupp]

I agree with @csordasmarton to simplify the makefile to the simple suggested one. At the end of the day it is only consists of 3 trivial files.

[zomen2]

• As you mentioned: "Later if someone wants to modify this file...". Why would somebody want to change the makefile? Because it changed the hierarchy of this "project". Your suggestion requires makefile modification too if some file is added or removed. Mine is resistant for that.

• In the howto document sometimes we clean the project and re-make it. Clean feature is not supported by your suggested solution.

Our purpose with that howto is to inspire users to play with it. There are some other issues in these C sources. If the user tries to repair them then he should re-make the project. But your suggested solution will not make if the user changes the divide.h file.

• The make can be called not only from that directory where the makefile resides. For example:

cd && make -f docs/examples/Makefile
should work. But your suggested makefile will not.

I think I have explained the requirements that were in my mind while creating that makefile.

I think if these requirements are valid then the "simplified" makefile will be at least comlex as mine is.

So, please specify your requirements against the makefile. And I will simplify it following them.

[csordasmarton]

With my solution there will be no generated files (output is redirected to /dev/null) so there is no need for clean target.

You don't have to step into the directory where the Makefile can be found, you can use the -C option of the make command for it if you would like to:

$ make -C docs/examples/
make: Entering directory '~/codechecker/docs/examples'
cc -Iincl -c src/divide.c -o /dev/null
cc -Iincl -c src/main.c -o /dev/null
make: Leaving directory '~/codechecker/docs/examples'

I still not recommend this complex Makefile for this simple example project but I will not block this PR. So on my side I finished the review of this patch.

[csordasmarton]

@zomen2 When you create a commit the window where you type the commit message will describe the recommended commit format. Please use the recommended format for commits. You can find the commit format also in our repository: https://github.com/Ericsson/codechecker/blob/master/.gitmessage.

Also add some description to the commit, what do you do in your patch.

[csordasmarton]

Please try to keep everything as simple as possible and do not complicate things.

[csordasmarton]

This Makefile is really complex and it contains a lot of unnecessary things. This is just a test project, so please keep it as simple as possible.

[dkrupp]

Some typos and some suggested extensions

[dkrupp]

please look ateh the simplified c example

[csordasmarton]

One import thing is to not use the --enable-all option for the CodeChecker analyze/check commands because it is not recommended. It will generate to much noise/reports. So please remove this option from this documentation too. Enable specific checkers with the --enable option.

[csordasmarton]

This is the subject of this patch. Later if someone wants to modify this file it will be hard to understand it, because it is very complex. So I still recommend to simplify this. The whole Makefile can look like this:

CFLAGS = -Iincl

all:
	$(CC) $(CFLAGS) -c src/divide.c -o /dev/null
	$(CC) $(CFLAGS) -c src/main.c -o /dev/null

[csordasmarton]

This is marked as resolved but it is not resolved yet. Please do not mark comment as resolved untill it is trully resolved or give me a reason why it is not resolved.

Comments are fixed.