update app_config.xml page on wiki

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

To post messages, you must log in.

AuthorMessage
boistordu

Send message
Joined: 8 Jan 12
Posts: 9
Belgium
Message 62290 - Posted: 23 May 2015, 21:12:15 UTC

please verify the code example for app_config.xml
there are [] in the app config file and we don't use it anymore... so it cause error
ID: 62290 · Report as offensive
Richard Haselgrove
Volunteer moderator
Volunteer tester
Help desk expert

Send message
Joined: 5 Oct 06
Posts: 2608
United Kingdom
Message 62291 - Posted: 23 May 2015, 21:22:59 UTC - in response to Message 62290.  

Please read the note at the head of the configuration page:

Note: Wherever you see square brackets [ ] used in the examples, these are not used. They show additional options. When using the specific piece of code, delete the square brackets, or the option you try to use will be ignored.

This applies to the app_config.xml file, just as it does to the cc_config.xml file documented in the first two major sections of the page - and indeed to all XML files documented in the Wiki.

[...] is a conventional way of indicating optional sections when documenting computer code, and is widely used in other contexts as well.
ID: 62291 · Report as offensive
boistordu

Send message
Joined: 8 Jan 12
Posts: 9
Belgium
Message 62293 - Posted: 23 May 2015, 21:51:21 UTC

ow okey sorry didn't know that we used it for comment. I was used to # or & this kind of signs.
so thanks for the precision
ID: 62293 · Report as offensive
Richard Haselgrove
Volunteer moderator
Volunteer tester
Help desk expert

Send message
Joined: 5 Oct 06
Posts: 2608
United Kingdom
Message 62294 - Posted: 23 May 2015, 22:02:17 UTC - in response to Message 62293.  

ow okey sorry didn't know that we used it for comment. I was used to # or & this kind of signs.
so thanks for the precision

That's OK, it makes sense when you get used to it.

Note that optional sections in app_config.xml may span several lines, and also be nested, like

   [<app_version>
       <app_name>uppercase</app_name>
       [<plan_class>mt</plan_class>]
       [<avg_ncpus>x</avg_ncpus>]
       [<ngpus>x</ngpus>]
       [<cmdline>--nthreads 7</cmdline>]
   </app_version>]

The whole <app_version> structure is optional, but if you want to use it, you must include the opening tag, an <app_name> tag, and the closing tag. You may want to use one or more of the optional lines as well.

It's hard to convey all that detail with #, &, ;, ', //, or any of the myriad other ways of indicating a comment line: the [ ] technique is both concise and precise.
ID: 62294 · Report as offensive

Message boards : Documentation : update 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.