Libs so #6

cyocum · 2018-01-24T13:13:24Z

This pull request amends the Makefiles for the project to allow for the creation of a libgherkin.so file which can be installed on a Unix/Linux machine and integrated in other projects. This is necessary for cucumber.ml.

Moved error_list.h and file_reader.h from src into the include directory so they can be used by other programs
Created the lib_so make target so that it will build the libgherkin.so file
Created the ../libs/libgherkin.so make target so that it will build the libgherkin.so file
Created the install and uninstall targets so that the user can install the created library and include files into the current system so that it can be compiled against in other projects.

* Added changes to Makefiles to create shared object * Moved file_reader.h to include file so it can be used in the library.

* Created a make install target based on Unix conventions * Moved error_list.h as it is required by a include/ file

brasmusson · 2018-01-25T19:42:05Z

Makefile

+	cd src; $(MAKE) CC=$(CC) $@
+.PHONY: libs_so
+
+install: libs_so


I'm not sure that the install and uninstall should be part of this makefile and make assumptions on where to install. If so the install and include directory should be defined in variables, so the they can be edited in one place (or overridden from the command line).

If there are install and uninstall rules, then shouldn't they also install the "bin/gherkin" CLI-binary?

Ok. This was requested by @aslakhellesoy because of things I said in the README file for Cucumber.ml project. I am not wedded to it because I have not used make in years and am (as you can see) fairly rusty at it.

We can remove install and uninstall, but I thought having them would simplify consumption for other developers and users.

Hardcoding things like "/usr/lib/" on several lines deep in makefile rules is not a good idea. The src/Makefile is deliberately written with make variable at the top, so that is should be straight forward for a user to modify those make variables for the special c compiler that the user might use. Any install/uninstall rules should also be appropriately parameterized ("/usr/lib/" does not work on Windows for instance).

brasmusson · 2018-01-25T19:42:42Z

Makefile

+.PHONY: libs_so
+
+install: libs_so
+	cp ./libs/libgherkin.so.1.0 /usr/lib/libgherkin.so.1.0


.1.0? Shouldn't it rather be the gherkin version?

I suggest we add a VERSION file with a single line containing the semver version. The upcoming version is 5.0.1. Then the Makefile can just cat that file.

brasmusson · 2018-01-25T19:43:35Z

src/Makefile

-CLANG_FLAGS=-c -Wall -Werror -g
+GCC_FLAGS=-c -Wall -Werror -g -fPIC 
+CLANG_FLAGS=-c -Wall -Werror -g -fPIC 
+GCC_SO_FLAGS= -shared -Wl,-soname,libgherkin.so.1


".1"? not ".1.0" as everywhere else?

Or better - take the version from a VERSION file as described above

brasmusson · 2018-01-25T19:45:23Z

src/Makefile

@@ -121,10 +125,14 @@ GHERKIN_CLI_OBJS= \
 	$(MKDIR_CMD) $(dir $@)
 	$(AR) $(AR_FLAGS) $@ $(UTILITIES_OBJS) $(PARSER_OBJS) $(AST_OBJS) $(COMPILER_OBJS) $(PICKLES_OBJS) $(EVENT_OBJS)

+../libs/libgherkin.so: $(UTILITIES_OBJS) $(PARSER_OBJS) $(AST_OBJS) $(COMPILER_OBJS) $(PICKLES_OBJS) $(EVENT_OBJS)


Unless declared ".PHONY", make rules shall create their target, so the make target should be "../libs/libgherkin.so".

I do not understand what you mean (again, my make experience is not great) so I am unable to comply. If you can make the change so I can see what you mean, that would be very helpful.

"A phony target is one that is not really the name of a file". "../libs/libgherkin.so" is "not really the name of a file" (the name of the file is "../libs/libgherkin.so.$(VERSION)". Since the basic principle of make is that the target of a rule is a file (unless there is a very compelling reason otherwise - for instance for rules with the target "all"), "../libs/libgherkin.so.$(VERSION)" is a much better target for this rule. It also enable the use of the automatic variable $@

brasmusson · 2018-01-25T19:46:07Z

src/Makefile

@@ -121,10 +125,14 @@ GHERKIN_CLI_OBJS= \
 	$(MKDIR_CMD) $(dir $@)
 	$(AR) $(AR_FLAGS) $@ $(UTILITIES_OBJS) $(PARSER_OBJS) $(AST_OBJS) $(COMPILER_OBJS) $(PICKLES_OBJS) $(EVENT_OBJS)

+../libs/libgherkin.so: $(UTILITIES_OBJS) $(PARSER_OBJS) $(AST_OBJS) $(COMPILER_OBJS) $(PICKLES_OBJS) $(EVENT_OBJS)
+	$(MKDIR_CMD) $(dir $@)
+	$(CC) $(GCC_SO_FLAGS) -o ../libs/libgherkin.so.1.0 $(UTILITIES_OBJS) $(PARSER_OBJS) $(AST_OBJS) $(COMPILER_OBJS) $(PICKLES_OBJS) $(EVENT_OBJS)


Use "-o $@" (after the make target has been fixed).

brasmusson · 2018-01-25T19:47:32Z

src/Makefile

 ../bin/gherkin_generate_tokens$(EXT): ../libs/libgherkin.a $(GENERATE_TOKEN_OBJS) Makefile
 	$(MKDIR_CMD) $(dir $@)
 	$(LD) $(LD_FLAGS) $(GENERATE_TOKEN_OBJS) -L../libs/ -lgherkin $(LD_LIBS) -o $@

-../bin/gherkin$(EXT): ../libs/libgherkin.a $(GHERKIN_CLI_OBJS) Makefile
+../bin/gherkin$(EXT): ../libs/libgherkin.a ../libs/libgherkin.so $(GHERKIN_CLI_OBJS) Makefile


"../libs/libgherkin.so" is not used for building "../bin/gherkin$(EXT)", so it should not be a dependency of the make rule.

Again, I do not understand. ../libs/libgherkin.so does build its target because it calls CC to build the actual shared object so I do not know what to do to address your comment.

The "../bin/gherkin" binary is statically linking the gherkin library. It does so using by using the "../libs/libgherkin.a" archive file. When you execute make ../bin/gherkin, "../libs/libgherkin.so" should not be built because it is not needed/used to produce "../bin/gherkin".

I think you added this to get "../libs/libgherkin.so" build when running make (with no argument), but this is the wrong way to achieve that (introducing a fake dependency to a make rule). To achieve that "../libs/libgherkin.so" build when running make, the "all" rule should be changed.

* Added VERSION file * Removed make install/unintstall * Added cat'ing the VERSION file to create the libgherkin file name

aslakhellesoy · 2018-01-26T13:22:41Z

@cyocum I changed the CI config so the build runs on OS X as well as Linux. That exposed some more issues that I also saw on my local Mac.

cyocum · 2018-01-26T13:26:36Z

Awesome, thanks. I will look into it shortly.

…

On 26 Jan 2018 1:22 p.m., "Aslak Hellesøy" ***@***.***> wrote: @cyocum <https://github.com/cyocum> I changed the CI config so the build runs on OS X as well as Linux. That exposed <https://travis-ci.org/cucumber/gherkin-c/builds/333695585?utm_source=github_status&utm_medium=notification> some more issues that I also saw on my local Mac. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAVYu1zV5UfOtaELjn_a_1ycmaypN-YQks5tOdGhgaJpZM4RrPB0> .

brasmusson · 2018-01-28T12:25:27Z

It seems that on Mac -install_name is the equivalent of -soname https://stackoverflow.com/a/8424297

aslakhellesoy · 2018-01-29T10:42:13Z

@brasmusson @cyocum what's left to do before I can merge this? The build is green.

cyocum · 2018-01-29T13:27:24Z

@aslakhellesoy I need to address @brasmusson comment above concerning the "all" make rule. After that, I think we are done unless @brasmusson has any other things he needs.

* Added libs_so to all target * Removed erroneous dependancy on ../bin/gherkin

aslakhellesoy · 2018-01-30T12:23:38Z

I've added .PHONY targets, so I think this is good to merge now?

brasmusson · 2018-02-09T19:45:35Z

I think it is good to merge now.

cyocum · 2018-02-09T21:43:13Z

Great. Thanks for all your help on this! It has been a while since I had to work on a makefile.

…

On Feb 9, 2018 11:45 AM, "Björn Rasmusson" ***@***.***> wrote: I think it is good to merge now. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAVYuzHkOptxQciREWVXpdS_bzTYLbk9ks5tTKBfgaJpZM4RrPB0> .

aslakhellesoy · 2018-02-10T13:39:13Z

Hi @cyocum,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

5.1.0 - 2018-05-30 Added * (.NET) - Better .NET Core support * Support for Aragonese (#298 danilat) * (C) build a shared libgherkin.so library which allows Gherkin to be used as a library. (Cucumber.ml currently uses this.) (cucumber/gherkin-c#6 cyocum) Changed * Pass the content type of a docstring down into its pickle string form (#292 rjwittams) * Fixed Russian equivalents of Given and Then. (#369 cerebellum13) Fixed * (C) Segfault when file does not exist (#394 #395 cyocum) * (JavaScript) (#374 #377 charlierudolph) * (Ruby, JavaScript) Remove berp.exe from packages (#289 aslakhellesoy) * (Go) fixes validation for go vet tool on latest versions (#330 l3pp4rd) * (Ruby) removed unneeded files from the gem

cyocum and others added 5 commits January 23, 2018 18:25

Added changes to Makefiles to create shared object

22762f9

* Added changes to Makefiles to create shared object * Moved file_reader.h to include file so it can be used in the library.

Made libgherkin.so build by default

65ab06d

Removed unnecessary linker directive

b974507

Created a make install and moved file

b0ade5f

* Created a make install target based on Unix conventions * Moved error_list.h as it is required by a include/ file

Attempting to fix error on CI with mingw-gcc

621dd46

brasmusson reviewed Jan 25, 2018

View reviewed changes

Chris Yocum and others added 2 commits January 26, 2018 10:11

Made changes based on reviewer feedback

8325fb2

* Added VERSION file * Removed make install/unintstall * Added cat'ing the VERSION file to create the libgherkin file name

Merge branch 'master' into libs_so

7a63949

Removed -soname from shared flags as this was causing failure on OSX

9e73887

cyocum and others added 3 commits January 29, 2018 19:11

Added libs_so to all target

9ca47fa

* Added libs_so to all target * Removed erroneous dependancy on ../bin/gherkin

Correct the target of the make rule for the dynamic library.

05c5675

gherkin: Add .PHONY targets, formatting

9f1cd4d

Merge branch 'master' into libs_so

0bd23be

aslakhellesoy merged commit ccb685f into master Feb 10, 2018

aslakhellesoy deleted the libs_so branch February 10, 2018 13:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Libs so #6

Libs so #6

cyocum commented Jan 24, 2018

brasmusson Jan 25, 2018

brasmusson Jan 25, 2018

cyocum Jan 26, 2018

aslakhellesoy Jan 26, 2018

brasmusson Jan 29, 2018

brasmusson Jan 25, 2018

aslakhellesoy Jan 26, 2018

brasmusson Jan 25, 2018

aslakhellesoy Jan 26, 2018

brasmusson Jan 25, 2018

cyocum Jan 26, 2018

brasmusson Jan 29, 2018

brasmusson Jan 25, 2018

brasmusson Jan 25, 2018

cyocum Jan 26, 2018

brasmusson Jan 28, 2018

aslakhellesoy commented Jan 26, 2018

cyocum commented Jan 26, 2018 via email

brasmusson commented Jan 28, 2018

aslakhellesoy commented Jan 29, 2018

cyocum commented Jan 29, 2018

aslakhellesoy commented Jan 30, 2018

brasmusson commented Feb 9, 2018

cyocum commented Feb 9, 2018 via email

aslakhellesoy commented Feb 10, 2018

Libs so #6

Libs so #6

Conversation

cyocum commented Jan 24, 2018

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

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

aslakhellesoy commented Jan 26, 2018

cyocum commented Jan 26, 2018 via email

brasmusson commented Jan 28, 2018

aslakhellesoy commented Jan 29, 2018

cyocum commented Jan 29, 2018

aslakhellesoy commented Jan 30, 2018

brasmusson commented Feb 9, 2018

cyocum commented Feb 9, 2018 via email

aslakhellesoy commented Feb 10, 2018