google-java-format icon indicating copy to clipboard operation
google-java-format copied to clipboard

Add a note on executable google-java-format

Open suztomo opened this issue 6 years ago • 11 comments

Google-java-format-diff expects an executable google-java-format (link), but this repository does not contain such file. This PR explains how to create such executable in README.md.

suztomo avatar Nov 05 '19 16:11 suztomo

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

googlebot avatar Nov 05 '19 16:11 googlebot

@googlebot I fixed it.

suztomo avatar Nov 05 '19 16:11 suztomo

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

googlebot avatar Nov 05 '19 16:11 googlebot

Google-java-format-diff expects an executable google-java-format (link), but this repository does not contain such file

I think this was addressed in #44.

cushon avatar Dec 17 '19 23:12 cushon

The issue 44 was addressed by adding flag to specify the location of the executable. Still this repository is missing how to create the executable.

suztomo avatar Dec 17 '19 23:12 suztomo

there's also https://github.com/google/google-java-format/commit/fa113c6df50fb97c5556c534eabe7b2745e7f993

cushon avatar Dec 17 '19 23:12 cushon

That command line option lets users specify a custom JAR file, without using an executable. This does not describe how to create the executable.

suztomo avatar Dec 17 '19 23:12 suztomo

aren't the two approaches equivalent?

cushon avatar Dec 18 '19 00:12 cushon

Yes the effect of two approaches (the custom JAR approach and the executable-in-PATH approach) is the same. This equivalence should not block enhancing the document for one approach. By the way, I like the executable-in-PATH approach because the command line parameter is shorter for google-java-format-diff.py.

suztomo avatar Dec 18 '19 00:12 suztomo

@eaftan Thank you for checking. Would you merge this PR? I don’t have write access.

suztomo avatar May 01 '20 18:05 suztomo

@suztomo I'm testing a new sync workflow. By approving this PR, I had hoped it would be automatically pulled into an internal CL, which we could then approve and submit internally. Then that change would be synced outward and this PR closed. But approving this didn't create the internal CL. Let me poke it and see if I can make it work.

eaftan avatar May 01 '20 20:05 eaftan