Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make generator documentation #955

Merged
merged 7 commits into from Dec 3, 2018

Conversation

Projects
None yet
3 participants
@danimtb
Copy link
Member

commented Nov 27, 2018

Documentation conan-io/conan#3773

@danimtb danimtb added this to the 1.10 milestone Nov 27, 2018

@ghost ghost assigned danimtb Nov 27, 2018

@ghost ghost added the stage: review label Nov 27, 2018

@danimtb danimtb removed their assignment Nov 27, 2018

@ghost ghost assigned danimtb Nov 27, 2018

@danimtb

This comment has been minimized.

Copy link
Member Author

commented Nov 28, 2018

@danimtb danimtb removed their assignment Nov 28, 2018

@ghost ghost assigned danimtb Nov 28, 2018

@danimtb danimtb removed their assignment Nov 28, 2018

@solvingj
Copy link
Contributor

left a comment

One issue of consistency, a few other description updates for clarity.

Show resolved Hide resolved integrations/make.rst Outdated
Show resolved Hide resolved reference/generators/make.rst Outdated
Show resolved Hide resolved reference/generators/make.rst Outdated
Show resolved Hide resolved reference/generators/make.rst Outdated
Show resolved Hide resolved reference/generators/make.rst Outdated
Show resolved Hide resolved reference/generators/make.rst Outdated
Show resolved Hide resolved reference/generators/make.rst Outdated

@ghost ghost assigned danimtb Nov 29, 2018

@danimtb

This comment has been minimized.

Copy link
Member Author

commented Nov 29, 2018

Hi @solvingj and thanks a lot for the review.

I have tried to follow the rules defined here: https://docs.conan.io/en/latest/reference/build_helpers/autotools.html#environment-variables

With the information indicated here: https://docs.conan.io/en/latest/reference/conanfile/attributes.html#cpp-info

Following that information the mapping will be:

cpp_info conanbuildinfo.mak Makefile
defines CONAN_DEFINES CPPFLAGS
includedirs CONAN_INCLUDE_PATHS CPPFLAGS
libdirs CONAN_LIB_PATHS LDFLAGS
libs CONAN_LIBS LIBS
cflags CONAN_CFLAGS CFLAGS
cppflags CONAN_CPPFLAGS CXXFLAGS

As you see, I think it is better to maintain a similar name for the cpp_info -> generator conversion but use the Make variable naming for the example (generator -> User side). WDYT?

The controversial part here is the cpp_info.cppflags that in my opinion it should have been called cpp_info.cxxflags

@danimtb danimtb referenced this pull request Nov 30, 2018

Merged

correct/improve/simplify makefile unit test #4018

5 of 5 tasks complete

@danimtb danimtb removed their assignment Nov 30, 2018

@solvingj

This comment has been minimized.

Copy link
Contributor

commented Dec 1, 2018

Yes, I mostly agree with it. There are still a few issues to work out though.

Autotools vs Make : LIBS vs LDLIBS
Sadly, and for reasons I have never found, Autotools chose to use a new variable name for this purpose. GNU Make originally used LOADLIBES, then changed to LDLIBS which is what is used today. Autotools came along later and used the shortened variable name LIBS. In short, I think that using LIBS is appropriate for the AutoTools Helper, and using LDLIBS is more likely what people would use in manually managed Makefiles. With that said, i think it's totally fine for the example. It will always be users preference.

CPP vs CXX
Thank you for clarifying. I actually completely forgot about this naming mismatch between Conan and Make/Autotools. I remember seeing it last year, perhaps I blacked it out. I guess I had been working so deeply with Make the past few months, when i came back to work on the generator I just lined things up the way that makes sense and never checked the docs. Sorry about that :(

Since it can never be fixed, I've gone ahead and updated my PR for the unit tests based on your feedback:
conan-io/conan#4018

So, after all that, this looks good :)

@danimtb

This comment has been minimized.

Copy link
Member Author

commented Dec 3, 2018

Thanks a lot for the feedback. I will come and update this PR with the variables in the test you proposed on conan-io/conan#4018 😃

@ghost ghost assigned danimtb Dec 3, 2018

@danimtb danimtb removed their assignment Dec 3, 2018

@jgsogo

jgsogo approved these changes Dec 3, 2018

Copy link
Member

left a comment

LGTM

@jgsogo jgsogo merged commit c11d064 into conan-io:develop Dec 3, 2018

1 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
license/cla Contributor License Agreement is signed.
Details

@ghost ghost removed the stage: review label Dec 3, 2018

danimtb added a commit that referenced this pull request Dec 7, 2018

Unpublished changes from develop branch (#967)
* Adds github settings file for portable labels (#951)

* Adds github settings file for portable labels

* make it generic

* improve seealso in android studio

* stettings

* #3883 Update inspect command (#940)

* #3883 Update inspect command

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* #3883 Update Inspect command output

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* #3883 Update default options for inspect

Signed-off-by: Uilian Ries <uilianries@gmail.com>

* Added entry in the MSBuild reference. (#854)

* Added entry in the MSBuild reference.

* Update output_binary_log and get_version()

* typo readme

* fix default

* clarification

* review

* undocumented parameter

* fix

* Make generator documentation (#955)

* Make generator documentation

* updated example

* Added toctrees

* review text

* review

* add missing variables for reference

* Updated with information of the test and with new table

* Get tool new parameters (#961)

* Add `include_prerelease` and `loose` option to version range expression (#938)

* Add `prerelease` and `strict` option to version range expression

* Update version_ranges.rst

* Change to `loose` and `include_prerelease` option

* Update version_ranges.rst

* Add example with both parameters

* Added CONAN_CMAKE_SILENT_OUTPUT description to the cmake generator (#962)

* Update attributes.rst (#966)

Fixing typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.