Appropriate license notice when bundling Verible

[Borja Penuelas]

Hi,

I am creating an extension to integrate Verible with the editor and have it provide code formatting and linting. https://github.com/bmpenuelas/systemverilog-formatter-vscode

To make it easier to adopt, I'm bundling the latest binaries you guys release (releases for Windows and Mac would be very welcome by many I think!). I have made ample references to the Verible license and sources in the extension description/readme, and kept the release directory contents unchanged, so the Apache 2.0 licenses are there too. Is this the proper way to do it?

Thanks! Looking forward to seeing this great project grow (and hopefully contributing a bit!)

BR,

Borja

[Tim 'mithro' Ansell]

Obviously we are not your lawyer (I don't have a legal degree either) and this is not an official response from Google. However.....

Google does publish the information they give to their Engineers at https://opensource.google/docs/ -- They have a section for the 'notice' licenses like Apache 2.0 -- https://opensource.google/docs/thirdparty/licenses/#notice and it says;

For downloaded Google ‘client’ products, the necessary notice files can be installed to some subdirectory of the Google product. For ‘embedded’ Google products, such as the Google Search Appliance, or Android apps that make use of ‘notice’-licensed source code, the required notices either need to be linked off of an “About” page or possibly included in printed documentation.

I was sure there was something more detailed in the documentation but I can't find it at the moment.

Verible was released to encourage growth in the SystemVerilog tooling ecosystem, hence things like vscode integration is exactly what we love to see!

Hope that helps!

Tim 'mithro' Ansell

--
You received this message because you are subscribed to the Google Groups "Verible Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to verible-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/verible-dev/CA%2BRW8FCQ0rD62Xngtco9E2jACLYP4FvLBpyAibQrJn5VxtNA4Q%40mail.gmail.com.

[Tim 'mithro' Ansell]

Hi Borja,

Just splitting the thread to discuss the vscode integration separately from the license discussion.

Seeing things like editor integration happening is super exciting and is exactly the type of thing we hoped would happen when releasing Verible publicly as open source. So please do keep up this awesome work!

I have a couple of questions for you;

 * Do you have a video or other recording of this integration working that I could share with some people?

 * How are you doing the vscode integration? There has been a lot of interest in having "language server" support in Verible but nobody has had the time to look into this.

 * Do you think that having the vscode support integrated into the verible repository directly would make sense? If not, we should add a section to the README which has links to integrations like this.

 * We would love to have prebuilt binaries for Windows / Mac. Travis CI (which is used to build the other binaries) already has Windows + Mac VMs, the only blocking issue is Verible actually building on those platforms which we could use help with.

    -- There is an open issue for Mac support at https://github.com/google/verible/issues/260

    -- I don't think there is an open issue for Windows support?

Looking forward to seeing more things like this happen!

Tim 'mithro' Ansell

On Sun, 3 May 2020 at 12:38, Borja Penuelas <bmpen...@gmail.com> wrote:

--

[Borja Penuelas]

Thanks for the links, it looks like the current arrangement abides by those instructions. If you ever find a better way to reference them do not hesitate to let me know.

Borja

To unsubscribe from this group and stop receiving emails from it, send an email to verib...@googlegroups.com.

[Borja Penuelas]

Sure, here you go, I have made a small demo recording of the current functionality: https://github.com/bmpenuelas/systemverilog-formatter-vscode/blob/master/media/demo_0.mp4

So far I have integrated it with the vscode "formatter" functionality and two independent commands that can be assigned a shortcut. The "formatter" registration is exposed by the editor API so that it allows the commands to be hooked to other editor flows, such as format-on-save. As a next step, I would like to integrate the linter as well.

Having the integrations with the editors in the same repo is certainly possible configuring the bundlers, but maybe keeping them separate makes things easier and more flexible. Both can work.

Borja

To unsubscribe from this group and stop receiving emails from it, send an email to verib...@googlegroups.com.

[David Fang]

I kind of think keeping the front-end/back-end codebases separate would be easier.  

As part of our documentation, we could include a section with pointers to IDE-like projects that actively use Verible's tools.

Regarding linter integration, there is also interest in structure linter diagnostics here:

https://github.com/google/verible/issues/257

Until then you can probably get off the ground running by splitting the linter output messages with regular expressions to extract file/line-numbers.

To unsubscribe from this group and stop receiving emails from it, send an email to verible-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/verible-dev/2501eaf2-2272-43c4-8b56-2cd83efe6b1a%40googlegroups.com.

[Borja Penuelas]

That will probably be my first approach as well, regexp parsing to json obj. 

I'll keep an eye on that issue, thanks for the link. Since I'm writing it in TS/JS, now I'm thinking I'll make it an isolated script that can be easily tuned and reused in other JS projects.

Borja

To view this discussion on the web visit https://groups.google.com/d/msgid/verible-dev/2501eaf2-2272-43c4-8b56-2cd83efe6b1a%40googlegroups.com.