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

Add description field to script.json #823

Open
ImperatorS79 opened this issue Jan 15, 2019 · 13 comments
Open

Add description field to script.json #823

ImperatorS79 opened this issue Jan 15, 2019 · 13 comments

Comments

@ImperatorS79
Copy link
Contributor

ImperatorS79 commented Jan 15, 2019

This file should contains files describing the verbs, for example:

  • What is the purpose of the verb.
  • What are the requirements (wine version, driver, ...).
  • Possible conflicts (example : "this verb modifies d3d11 related dll, be careful with other verbs that do the same !").

Those informations should be displayed when someone wants to install a verb from the container tab for example.

@plata
Copy link
Collaborator

plata commented Jan 15, 2019

The general idea was that verbs are first class citizens like any other app/plugin etc. Therefore it would be difficult (conceptionally) to add a different json for verbs.
Is there anything which should be parsed/evaluated automatically? How would you want to use the information? If it's really only about displaying something, wouldn't a generic "note"/"description" field be enough?

@ImperatorS79
Copy link
Contributor Author

Yes, it's the same purpose as application.json -> when you click on it it displays the informations.

@plata
Copy link
Collaborator

plata commented Jan 15, 2019

Then I would suggest simply a "description" field in script.json.

@ImperatorS79
Copy link
Contributor Author

Ok for me.

@plata plata changed the title Add verbs.json to all verbs. Add description to script.json Jan 15, 2019
@ImperatorS79 ImperatorS79 changed the title Add description to script.json Add description field to script.json for verbs. Jan 15, 2019
@plata
Copy link
Collaborator

plata commented Jan 15, 2019

^^ Same time

@plata
Copy link
Collaborator

plata commented Jan 15, 2019

It should not only be for verbs but in general.

@ImperatorS79
Copy link
Contributor Author

ImperatorS79 commented Jan 15, 2019

I think we could even add a "conflict" field for listing conflicting verbs like winetricks does.

@plata
Copy link
Collaborator

plata commented Jan 16, 2019

Possible but probably hard to maintain (imagine e.g. a script is renamed).

@ImperatorS79
Copy link
Contributor Author

If a script is renamed, you have to update every script calling it... So I do not think a script will be renamed.

@plata
Copy link
Collaborator

plata commented Jan 16, 2019

Let's go for the description and then see what else we might need.

@plata plata changed the title Add description field to script.json for verbs. Add description field to script.json Jan 16, 2019
@plata
Copy link
Collaborator

plata commented Mar 3, 2019

How does this relate to #361? Do we need both (I don't think so). @madoar ?

@madoar
Copy link
Collaborator

madoar commented Mar 3, 2019

I think that #361 targets the same problem. I don't think we require both issues.

@plata
Copy link
Collaborator

plata commented Mar 3, 2019

Then I would prefer "description" over "note". So in my opinion we can close #361.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants