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

Refactor, add variables from yocto docs, add hover definition for yocto docs, etc #59

Merged
merged 11 commits into from
Nov 9, 2023

Conversation

WilsonZiweiWang
Copy link
Collaborator

@WilsonZiweiWang WilsonZiweiWang commented Nov 7, 2023

  1. Refactored the bitbakeDocScanner. It won't store completion items. The conversion happens in onCompletion handler.

  2. Added variables from yocto docs.
    image

  3. Added hover definition for yocto tasks.
    image

  4. Updated the tests.

@WilsonZiweiWang WilsonZiweiWang changed the title Refactor, add variables from yocto docs, add hover definition for yocto docs Refactor, add variables from yocto docs, add hover definition for yocto docs, etc Nov 7, 2023
@WilsonZiweiWang
Copy link
Collaborator Author

@deribaucourt
I added the variables from Yocto docs but I noticed that some variables share the same name. I wonder how we want to handle the hover definition in a case like that.

@WilsonZiweiWang WilsonZiweiWang self-assigned this Nov 7, 2023
@idillon-sfl
Copy link
Member

@deribaucourt I added the variables from Yocto docs but I noticed that some variables share the same name. I wonder how we want to handle the hover definition in a case like that.

Here's an idea: We could eventually add an option to select between "yocto" mode and "pure bitbake" mode.

But as it seems nobody cares about "pure bitbake" mode, maybe we could stick to the "yocto" mode until there's a demand for it.

@deribaucourt
Copy link
Member

@WilsonZiweiWang

But as it seems nobody cares about "pure bitbake" mode, maybe we could stick to the "yocto" mode until there's a demand for it.

I wouldn't say nobody cares about "pure bitbake", but yes they are extremly rare. Our extension addressing the broader public should focus on Yocto.

@deribaucourt
Copy link
Member

@deribaucourt I added the variables from Yocto docs but I noticed that some variables share the same name. I wonder how we want to handle the hover definition in a case like that.

Do you have example variable definitions being duplicated? I'd like to compare them to tell you which is better. Picking any of the two is already fine for this PR. Duplication may very well be addressed in the Yocto documentation itself.

@WilsonZiweiWang WilsonZiweiWang force-pushed the Feature-10412-add-variables-from-yocto-docs branch from 9d2e9c8 to a4b7611 Compare November 8, 2023 17:40
@WilsonZiweiWang
Copy link
Collaborator Author

@deribaucourt I added the variables from Yocto docs but I noticed that some variables share the same name. I wonder how we want to handle the hover definition in a case like that.

Do you have example variable definitions being duplicated? I'd like to compare them to tell you which is better. Picking any of the two is already fine for this PR. Duplication may very well be addressed in the Yocto documentation itself.

image
image

@deribaucourt
Copy link
Member

@deribaucourt I added the variables from Yocto docs but I noticed that some variables share the same name. I wonder how we want to handle the hover definition in a case like that.

Do you have example variable definitions being duplicated? I'd like to compare them to tell you which is better. Picking any of the two is already fine for this PR. Duplication may very well be addressed in the Yocto documentation itself.

image image

The Yocto documentation is more complete. You should only provide it when the bitbake doc collides.

@WilsonZiweiWang WilsonZiweiWang force-pushed the Feature-10412-add-variables-from-yocto-docs branch from a4b7611 to f40fb0f Compare November 9, 2023 15:47
@WilsonZiweiWang WilsonZiweiWang merged commit 1cc8a9c into staging Nov 9, 2023
@WilsonZiweiWang WilsonZiweiWang deleted the Feature-10412-add-variables-from-yocto-docs branch November 9, 2023 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants