app_config.xml page on wiki

Message boards : Documentation : app_config.xml page on wiki
Message board moderation

To post messages, you must log in.

AuthorMessage
Profile Agentb
Help desk expert
Avatar

Send message
Joined: 30 May 15
Posts: 265
United Kingdom
Message 62916 - Posted: 5 Jul 2015, 11:39:13 UTC

Firstly, thank you to those who document boinc wonderfully well.

I have recent used this page

Application configuration

for the first time, and would like to make a couple of suggestions.

I found the documented application called "uppercase" confusing, (and yes i did type the application name in uppercase without thinking. lol)

May i suggest where <name>uppercase</name> or <app_name>uppercase</app_name> is used replace it with Application_Name

I knew where to look to find client_state.xml, but a link to where to find it would be helpful, and a reminder that this is not the name displayed by boinc manager or the operating system.

Application_Name may contain uppercase, lowercase, numerics and special characters.



<app_version> questions.

I did not use the <app_version> stanza.

How is the version number specified? i can't see the parameter to set in the app_config.xml file.

Where is the version number found? I think the answer is in the app_config.xml file as <app_version_num>

<plan_class> is not well documented.


Lastly,it would be helpful to give the reader some links to examples.
ID: 62916 · Report as offensive
Richard Haselgrove
Volunteer moderator
Volunteer tester
Help desk expert

Send message
Joined: 5 Oct 06
Posts: 2821
United Kingdom
Message 62918 - Posted: 5 Jul 2015, 13:02:51 UTC - in response to Message 62916.  
Last modified: 5 Jul 2015, 13:03:32 UTC

Firstly, thank you to those who document boinc wonderfully well.

I have recent used this page

Application configuration

for the first time, and would like to make a couple of suggestions.

I found the documented application called "uppercase" confusing, (and yes i did type the application name in uppercase without thinking. lol)

May i suggest where <name>uppercase</name> or <app_name>uppercase</app_name> is used replace it with Application_Name

I knew where to look to find client_state.xml, but a link to where to find it would be helpful, and a reminder that this is not the name displayed by boinc manager or the operating system.

Application_Name may contain uppercase, lowercase, numerics and special characters.

That's worth thinking about, and I'll maybe implement it when the web site finds its style sheet again, so I can see the layout properly.

It would require some adjustment to the example section:

name
short name of the application as found in the corresponding <name>xxxxx</name> tags in your client_state.xml file. In the above example, the application name is "uppercase".



<app_version> questions.

I did not use the <app_version> stanza.

How is the version number specified? i can't see the parameter to set in the app_config.xml file.

Where is the version number found? I think the answer is in the app_config.xml file as <app_version_num>

I don't think the granularity of app_config goes down as low as the version number level. The hierarchy is

Application
... Plan class
... ... Version (number)

If you were able to use it, you would take it from <version_num> in the <app_version> section of client_state.xml


<plan_class> is not well documented.

Lastly,it would be helpful to give the reader some links to examples.

I'll leave that for more experienced documenters to consider.
ID: 62918 · Report as offensive
Richard Haselgrove
Volunteer moderator
Volunteer tester
Help desk expert

Send message
Joined: 5 Oct 06
Posts: 2821
United Kingdom
Message 62919 - Posted: 5 Jul 2015, 14:01:09 UTC

Application_Name and example adjusted.
ID: 62919 · Report as offensive
Profile Ageless
Volunteer moderator
Project administrator
Volunteer tester
Help desk expert
Avatar

Send message
Joined: 29 Aug 05
Posts: 12671
Netherlands
Message 62922 - Posted: 5 Jul 2015, 17:57:10 UTC - in response to Message 62916.  

Application_Name may contain uppercase, lowercase, numerics and special characters.

I don't concur.
<name></name> contains the same name of the application as stored in client_state.xml, and is just the short application name used by BOINC and the project. It is the <user_friendly_name></user_friendly_name> in app_info.xml and client_state.xml that can contain uppercase and lowercase characters, because this reads in a user friendly way the application's name.
Both can contain numerics and special characters.
Jord
Please do not private message me for tech support. Use the forums for that. Tech PMs will be ignored.

quote: "I'm an apostrophe, I'm just a symbol to remind you that there's more to see"
ID: 62922 · Report as offensive
Profile Agentb
Help desk expert
Avatar

Send message
Joined: 30 May 15
Posts: 265
United Kingdom
Message 62923 - Posted: 5 Jul 2015, 18:37:05 UTC - in response to Message 62922.  

Application_Name may contain uppercase, lowercase, numerics and special characters.

I don't concur.


The wiki still includes (and i should have pointed to this on my original post) these two lines towards the end of the page

All the tags use lowercase characters.
The app_name may contain uppercase characters.


To be clearer, the second line, and all similar references to application name valid characters could simply be deleted. There is no reason to make comment on the case or otherwise, it simply needs to match (exactly) what is in the client_state.xml - or have i misunderstood something?
ID: 62923 · Report as offensive
Profile Ageless
Volunteer moderator
Project administrator
Volunteer tester
Help desk expert
Avatar

Send message
Joined: 29 Aug 05
Posts: 12671
Netherlands
Message 62925 - Posted: 5 Jul 2015, 19:01:36 UTC

Having checked some further into it, I see I am wrong.
For example, Einstein@Home had an application stored in client_state.xml called
<name>einsteinbinary_BRP5</name>


I've adjusted the wiki to hopefully make things more clear.
Jord
Please do not private message me for tech support. Use the forums for that. Tech PMs will be ignored.

quote: "I'm an apostrophe, I'm just a symbol to remind you that there's more to see"
ID: 62925 · Report as offensive
Profile Agentb
Help desk expert
Avatar

Send message
Joined: 30 May 15
Posts: 265
United Kingdom
Message 62927 - Posted: 5 Jul 2015, 22:29:29 UTC - in response to Message 62925.  

I've adjusted the wiki to hopefully make things more clear.


Thank you Jord.
ID: 62927 · Report as offensive

Message boards : Documentation : app_config.xml page on wiki

Copyright © 2018 University of California. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.